Docs: Make @doc macro return the value of documented expression
#59882
+96
−6
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
vtjnash
changed the title
vtjnash
changed the title
@doc macro return the value of documented expression
mlechu
reviewed
Oct 20, 2025
Change the @doc macro implementation to return the result of the original expression instead of the binding. This allows using the documented definition in an assignment or other expression context. For example, documenting a function now returns the function itself: ```julia result = begin "docstring" function f end end ``` Add special handling for `global` declarations to return nothing instead of failing with a syntax error, since `x = begin; global x; end` is not valid Julia syntax. 🤖 Generated with help from Claude Code
vtjnash
force-pushed
the
jn/at-docs-return
branch
from
cd45803 to
1a07c92
Compare
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.
Change the
@docmacro implementation to return the result of the original expression instead of the Docs.Binding object. This allows using the documented definition in an assignment or other expression context.For example, documenting a function now returns the function itself:
Add special handling for
globaldeclarations to return nothing instead of failing with a syntax error, sincey = begin; global x; endis not valid Julia syntax.🤖 Generated with help from Claude Code