-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Copying docstrings with @doc
macro in packages doesn't work on master
#52141
Comments
JeffBezanson
added a commit
that referenced
this issue
May 16, 2024
KristofferC
pushed a commit
that referenced
this issue
May 27, 2024
KristofferC
pushed a commit
that referenced
this issue
May 27, 2024
DilumAluthge
pushed a commit
that referenced
this issue
Jun 3, 2024
lazarusA
pushed a commit
to lazarusA/julia
that referenced
this issue
Jul 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Accessing the documentation attached to a binding with
@doc name
seems to returnnothing
inside a package, so doing something like copying a docstring from one binding to another no longer works.For example, with a new package:
and writing the module
The docstring for
B
exists on Julia 1.10 and prior ...but appears to be
nothing
on master:After some digging through the Docs code, I've found the pair of PRs #48594 and #51399 that effect
Base.Docs.docm()
. The former was merged before 1.10 was branched, so that doesn't appear to be the cause — therefore I'm guessing the movement of REPL out of the system image impacted this, though I haven't bisected to be sure.Using the guess that
@doc
needsREPL
to function, I tried adding it to the package dependencies and loading inside the package, and it does appear to fix the problem with the docstring not copying:and then
Of course, I'd rather not have to add a dependency on the REPL.
The text was updated successfully, but these errors were encountered: