Skip to content

Updated link to config docs - #1362

Merged
tobyallwood merged 2 commits into
mainfrom
tobyallwood/doc-link-update
Jun 4, 2026
Merged

tobyallwood merged 2 commits into
mainfrom
tobyallwood/doc-link-update

Conversation

@tobyallwood

Copy link
Copy Markdown
Collaborator

Closes #1350

When updating docs a link in __init__.py was missed that points to the configuration documentation, this has been fixed.

@ubdbra001 ubdbra001 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One query

Comment thread topostats/__init__.py Outdated
TOPOSTATS_COMMIT = ""
CONFIG_DOCUMENTATION_REFERENCE = """# For more information on configuration and how to use it:
# https://afm-spm.github.io/TopoStats/main/configuration.html\n"""
# https://afm-spm.github.io/TopoStats/dev/usage/configuration/\n"""

@ubdbra001 ubdbra001 Jun 4, 2026 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just double checking: Should this be dev or latest?
latest will be the docs for the latest release
dev will be for the most recent commit

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, yeah latest would be best

@tobyallwood
tobyallwood requested a review from ubdbra001 June 4, 2026 11:40

@ubdbra001 ubdbra001 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to merge!

@tobyallwood
tobyallwood added this pull request to the merge queue Jun 4, 2026
Merged via the queue into main with commit f7754dc Jun 4, 2026
7 checks passed
@tobyallwood
tobyallwood deleted the tobyallwood/doc-link-update branch June 4, 2026 12:10
@ubdbra001 ubdbra001 mentioned this pull request Jul 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

__init__ references old docs

2 participants