Add "nodoc" annotation #3978
Merged
Add "nodoc" annotation #3978
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
SeanTAllen
force-pushed
the
nodoc-annotation
branch
from
90256e4
to
a840f58
Compare
SeanTAllen
added
the
changelog - added
|
I've also added a manual CHANGELOG entry to the "changed" aspect of this that removed the previous "sean quick hack" version. |
The can be used to control the pony compilers documentation generation, any structure that can have a docstring (except packages) can be annotated with \nodoc\ to prevent documentation from being generated. This replaces a hack I put in years ago to filter out items that were "for testing" by looking for Test and _Test at the beginning of the name as well as providing UnitTest or TestList. All standard library test items have been annotated with \nodoc\ to keep them continuing to not have documentation generated by our standard process of creating the standard library documentation site. ponylang org libraries will need to be updated as well. Note that the "should we include this package" hack to filter out packages called "test" and "builtin_test" still exists for the time being until we have further discussion. Closes #3332
SeanTAllen
force-pushed
the
nodoc-annotation
branch
from
a840f58
to
201d3ce
Compare
|
Tutorial PR opened: |
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.
The can be used to control the pony compilers documentation generation,
any structure that can have a docstring (except packages) can be
annotated with \nodoc\ to prevent documentation from being generated.
This replaces a hack I put in years ago to filter out items that
were "for testing" by looking for Test and _Test at the beginning of
the name as well as providing UnitTest or TestList.
All standard library test items have been annotated with \nodoc\ to
keep them continuing to not have documentation generated by our
standard process of creating the standard library documentation site.
ponylang org libraries will need to be updated as well.
Note that the "should we include this package" hack to filter out
packages called "test" and "builtin_test" still exists for the time
being until we have further discussion.
Closes #3332