Skip to content

HISTORY: document @doc return value change in 1.13 (#61877)#62147

Open
tejaswiverma121-byte wants to merge 2 commits into
JuliaLang:masterfrom
tejaswiverma121-byte:history-doc-at-doc-61877
Open

HISTORY: document @doc return value change in 1.13 (#61877)#62147
tejaswiverma121-byte wants to merge 2 commits into
JuliaLang:masterfrom
tejaswiverma121-byte:history-doc-at-doc-61877

Conversation

@tejaswiverma121-byte

Copy link
Copy Markdown
Contributor

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, @doc returned a Docs.Binding object. In Julia 1.13, @doc instead 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.md rather than NEWS.md. A companion PR (#<PR_NUMBER>) adds the equivalent entry to NEWS.md on the backports-release-1.13 branch.

Closes #61877

@tejaswiverma121-byte

tejaswiverma121-byte commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

@lgoettgens is it okay this time ?

Comment thread HISTORY.md Outdated
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]).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@lgoettgens

Copy link
Copy Markdown
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.

A companion PR (#<PR_NUMBER>) adds the equivalent entry to NEWS.md on the backports-release-1.13 branch.

This is still missing

@tejaswiverma121-byte

Copy link
Copy Markdown
Contributor Author

ohk i will look into it

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.

Document breaking change to @doc

2 participants