HISTORY: document @doc return value change in 1.13 (#61877)#62147
Open
tejaswiverma121-byte wants to merge 2 commits into
Open
HISTORY: document @doc return value change in 1.13 (#61877)#62147tejaswiverma121-byte wants to merge 2 commits into
tejaswiverma121-byte wants to merge 2 commits into
Conversation
Contributor
Author
|
@lgoettgens is it okay this time ? |
lgoettgens
reviewed
Jun 17, 2026
Comment on lines
+16
to
+19
| * The return value of `@doc` has changed: it now returns the documented | ||
| expression (e.g. a function or type) instead of a `Docs.Binding` object | ||
| as in previous versions. Code that depended on `@doc` returning a | ||
| `Docs.Binding` will need to be updated ([#59882], [#60681]). |
Contributor
There was a problem hiding this comment.
Suggested change
| * The return value of `@doc` has changed: it now returns the documented | |
| expression (e.g. a function or type) instead of a `Docs.Binding` object | |
| as in previous versions. Code that depended on `@doc` returning a | |
| `Docs.Binding` will need to be updated ([#59882], [#60681]). | |
| * The return value of `@doc` has changed: it now returns the documented expression (e.g. a function or type) instead of a `Docs.Binding` object as in previous versions. Code that depended on `@doc` returning a `Docs.Binding` will need to be updated ([#59882], [#60681]). |
this file seems to have arbitrarily long lines
Contributor
|
From a technical level, this looks fine (one comment above). I cannot judge the contents; you will have to wait for someone knowledgeable with the change for that.
This is still missing |
Contributor
Author
|
ohk i will look into it |
c31449f to
b9923c0
Compare
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
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.
Documents the breaking change to
@doc's return value that was introduced in Julia 1.13 via #59882, as requested in #61877.In Julia 1.12 and earlier,
@docreturned aDocs.Bindingobject. In Julia 1.13,@docinstead returns the documented expression itself (e.g. a function or type). This change was intentional but was missing from the changelog.Since 1.13 has already been released, this documents the change in
HISTORY.mdrather thanNEWS.md. A companion PR (#<PR_NUMBER>) adds the equivalent entry toNEWS.mdon thebackports-release-1.13branch.Closes #61877