Make Documenter Syntax-versioning aware #2874
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Default to the syntax version of the module that contains the doctest (so that upgrading julia version doesn't break doctests if they use old syntax) but provide an explicit override so that in principle one could document previous syntax (e.g. to demonstrate how to use something if the user syntax is older than the package syntax). I don't think that'll come up all that often (except for possibly in base), but might as well have the facility.
fingolfin
reviewed
Feb 3, 2026
Collaborator
fingolfin
left a comment
fingolfin
left a comment
There was a problem hiding this comment.
Thanks that looks pretty good. Some minor nitpicks in comments. Also, this needs a changelog entry.
Contributor
Author
|
@fingolfin Good to go? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Default to the syntax version of the module that contains the doctest (so that upgrading julia version doesn't break doctests if they use old syntax) but provide an explicit override so that in principle one could document previous syntax (e.g. to demonstrate how to use something if the user syntax is older than the package syntax). I don't think that'll come up all that often (except for possibly in base), but might as well have the facility.