docs(chpldoc): replace pragma 'no doc' with attribute #21915
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
Signed-off-by: arezaii <ahmad.rezaii@hpe.com>
1 task
lydia-duncan
approved these changes
Mar 16, 2023
arezaii
added a commit
that referenced
this pull request
Mar 16, 2023
…21916) This PR updates deprecated docs to include the `@deprecated` attribute instead of the `deprecated` keyword. As with #21915, this required changing the code block style from Chapel to plain text as the sphinxcontrib-chapeldomain and pygments packages both require updates to parse attributes. Future work will change these back to Chapel blocks once those updated packages are available. TESTING: - [x] build docs locally and inspect deprecation page reviewed by @lydia-duncan - thank you!
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 PR updates the
chpldocdocumentation to change the method for suppressing generated documentation frompragma "no doc"to@chpldoc.nodoc.This required changing the code block style from Chapel to plain text as the sphinxcontrib-chapeldomain and pygments packages both require updates to parse attributes.
Future work will change these back to Chapel blocks once those updated packages are available.
TESTING:
chpldocpagereviewed by @lydia-duncan - thanks!