docstrings for Base, Core, Main, Module #31131
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
base/docs/basedocs.jl
Outdated
|
|
||
| The base library of Julia. `Base` is a module that contains basic functionality (the contents of `base/`). All modules implicitly contain `using Base`, since this is needed in the vast majority of cases. | ||
| """ | ||
| kw"Base" |
There was a problem hiding this comment.
I'm not sure why these would be handled like keywords. Can we attach the doc strings to the modules themselves instead?
There was a problem hiding this comment.
Note that kw"Base" was introduced before this PR. I guess maybe for some kind of bootstrap reason? Anyway in case of Main and Core I needed to do this in order to make e.g.
help?> Corework.
There was a problem hiding this comment.
This is what I get, if I remove kw:
help?> Base
search: Base basename AbstractSet Broadcast broadcast broadcast! AbstractString AbstractDisplay set_zero_subnormals get_zero_subnormals
No documentation found.
No docstring found for module Base.
help?> Main
search: Main DomainError maxintfloat SegmentationFault maximum maximum! Matrix BitMatrix mapslices DenseMatrix timedwait StridedMatrix
No documentation found.
No docstring found for module Main.
help?> Core
search: Core isconcretetype searchsorted searchsortedlast searchsortedfirst code_lowered @code_lowered StackOverflowError code_warntype
No documentation found.
No docstring found for module Core.
help?> Main.Core
No documentation found.
No docstring found for module Core.
help?> Core.Main
Main
Main is the top-level module, and Julia starts with Main set as the current module. Variables defined at the prompt go in Main, and
varinfo lists variables in Main.
julia> @__MODULE__
Main
help?> Main.Base
No documentation found.
No docstring found for module Base.
help?> Base
search: Base basename AbstractSet Broadcast broadcast broadcast! AbstractString AbstractDisplay set_zero_subnormals get_zero_subnormals
No documentation found.
No docstring found for module Base.There was a problem hiding this comment.
I see. It seems to work if you document a module's "self binding", i.e. Base.Base, Core.Core, and Core.Main.Main.
fredrikekre
requested changes
Feb 26, 2019
|
Looks good to me. @fredrikekre: looks like all your requested changes have been resolved. Please merge if you're good with this now. |
fredrikekre
approved these changes
Mar 3, 2019
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.
Towards #26919