names docstring: qualify non-exported cross-refs
#52745
Merged
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
|
(It would be nice if the docsystem did this automatically somehow.) |
fingolfin
reviewed
Feb 10, 2024
base/reflection.jl
Outdated
| @@ -84,7 +84,7 @@ are also included. Names are returned in sorted order. | |||
| As a special case, all names defined in `Main` are considered \"public\", | |||
| since it is not idiomatic to explicitly mark names from `Main` as public. | |||
|
|
|||
| See also: [`isexported`](@ref), [`ispublic`](@ref), [`@locals`](@ref Base.@locals), [`@__MODULE__`](@ref). | |||
| See also: [`Base.isexported`](@ref), [`Base.ispublic`](@ref), [`Base.@locals`](@ref Base.@locals), [`@__MODULE__`](@ref). | |||
There was a problem hiding this comment.
Maybe like this (I am not sure what the @ref Base.@locals does, so I might be guessing wrong)
Suggested change
| See also: [`Base.isexported`](@ref), [`Base.ispublic`](@ref), [`Base.@locals`](@ref Base.@locals), [`@__MODULE__`](@ref). | |
| See also: [`Base.isexported`](@ref), [`Base.ispublic`](@ref), [`Base.@locals`](@ref), [`@__MODULE__`](@ref). |
fingolfin
approved these changes
Feb 10, 2024
|
I resolved the conflict and applied my suggested change while doing so, but someone should who knows about |
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.
It seems like cross-references to non-exported symbols, like
ispublic, should be qualified — otherwise it is confusing since looking them up fails.