Move RST 'data' docstrings inline #17417
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
| @@ -3,7 +3,7 @@ module GenStdLib | |||
| import Base.Docs: Binding, DocStr | |||
|
|
|||
| # Constants. | |||
| const DOCSTRING_DIRECTIVE = r"^(.. (function|type|variable):: ).*" | |||
| const DOCSTRING_DIRECTIVE = r"^(.. (function|type|variable|data):: ).*" | |||
There was a problem hiding this comment.
@MichaelHatherly I originally introduced the variable directive for the purpose of keeping docstrings in sync with the manual. We can definitely have the data directive sync with docstrings but then we should probably remove the variable directive then.
Ref #16328
There was a problem hiding this comment.
Done in c539a66.
|
does this close #16303 all the way? |
| to an `Int64`. | ||
| """ | ||
| Period(v) | ||
|
|
||
| # Instant types represent different monotonically increasing timelines |
There was a problem hiding this comment.
I guess these comments are redundant now?
There was a problem hiding this comment.
Yeah, they say pretty much the same thing now. Will remove.
There was a problem hiding this comment.
Done in 6535f71.
|
LGTM! |
This moves all `.. data::` docstrings found in the RST docs into `base/` source files, so all docstrings found in the docs are now actual docstrings. This will help with the markdown manual conversion. Minor formatting changes include addition of some fullstops in several docstrings, and reformatting of the `StackTrace` docstring.
This moves the docs for `build_sysimg` inline in `contrib/build_sysimg.jl`. Adds an additional condition to the `build_sysimg.jl` file so that we can safely include the file in `genstdlib.jl` without a system image being built unintentionally.
Replace with `.. data::` instead since they are both used for the same kind of docstrings.
MichaelHatherly
force-pushed
the
mh/missing-const-docs
branch
from
9e0a4d2 to
c539a66
Compare
|
Thanks for reviewing, I'll merge once CI is green then. |
|
actually I think threadcall is still undocumented |
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.
This moves all
.. data::docstrings found in the RST docs intobase/source files, so all docstrings found in the docs are now actual docstrings. This will help with the markdown manual conversion.Minor formatting changes include addition of some fullstops in several docstrings, and reformatting of the
StackTracedocstring.The only troublesome docstring is"Fixed" now: in 32185da I'vebuild_sysimgfound in/devdocs/sysimg.rst, which doesn't actually exist as far as I can see. Not quite sure what to do about that one.included thecontrib/build_sysimg.jlfile indoc/genstdlib.jlso that it's docstring can live in the appropriate place. Note thatbuild_sysimgwon't get called since I've made it's execution conditional onGenStdLibnot being defined. If anyone has a more straightforward solution that would be great.