PoC: Document each rcParam individually #28930
Draft
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
Taking cues from the math symbol table, this adds a directive to generate a listing from the `RcParams` dictionary, with types taken from the validators (partially complete), though there could perhaps be other ways to implement it. Then the `rc` role is updated to point to these individual anchors. We also have nowhere to put the documentation for each one yet, so the actual information is all just stubs.
|
I believe we eventually should have a function-based/declarative approach to specifying rcParams, similar to e.g. This would bind all relevant information together and make it easy to generate documentation. A minor obstacle would be to generate a reasonably formatted default |
1 task
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.
PR summary
Taking cues from the math symbol table, this adds a directive to generate a listing from the
RcParamsdictionary, with types taken from the validators (partially complete), though there could perhaps be other ways to implement it. Then thercrole is updated to point to these individual anchors.We also have nowhere to put the documentation for each one yet, so the actual information is all just stubs. This would be the main obstacle to completing this change.
PR checklist