Fix doc string tests in prep for Julia v1.11 release #16
Conversation
This file contains 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
The change in JuliaLang/julia#54499 fixed the ability to access/copy doc strings without needing to take an explicit dependency on the REPL package, but the returned object does not trivially reduce back to a string, as described in issue JuliaLang/julia#54664. Instead of waiting for that issue to get resolved at the Julia level to fix our tests, just add a helper shim to the tests to access the desired information. The goal is to just ensure that the macro `@__doc__` expression is correctly used to permit documenting the generated type definitions, so we don't really care about the specific form as long as Julia uses it correctly within the docs system.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The change in JuliaLang/julia#54499 fixed the ability to access/copy doc strings without needing to take an explicit dependency on the REPL package, but the returned object does not trivially reduce back to a string, as described in issue JuliaLang/julia#54664.
Instead of waiting for that issue to get resolved at the Julia level to fix our tests, just add a helper shim to the tests to access the desired information. The goal is to just ensure that the macro
@__doc__expression is correctly used to permit documenting the generated type definitions, so we don't really care about the specific form as long as Julia uses it correctly within the docs system.