Use substitutions in docs #3366
Merged
Conversation
This file contains hidden or 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
Viicos
commented
Nov 16, 2022
Viicos
commented
Nov 16, 2022
harshil21
requested changes
Nov 16, 2022
There was a problem hiding this comment.
Thanks for the PR. You'll also have to update substitutions.rst to say #3363 (comment) instead.
|
Thank you for your contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Related to #3363
Turns out some other substitutions could be used other than the already existing ones (one downside being that you'll have to check the
docs/substitutions/*.rstfiles to see what is the description of a parameter when reading the doc in code).