Update contributing rst with command/cell help info #4929
+508
−149
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
Very briefly on command help Mostly focused on v1 and v2 of the cell help, but still largely bullet points
Add line about v2 cell help Update docs path to point to the right place
First couple sections done, plus a couple formatting tidy ups later on.
KrystalDelusion
force-pushed
the
docs-preview-contributing_help
branch
from
af3f9d8 to
1186ca8
Compare
Also moved them to the bottom, instead of being under the "command help" heading. Now includes more info about cells, and the custom sphinx domains/directives/roles we have.
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.
What are the reasons/motivation for this change?
Developer documentation is lacking and/or out of date. This PR serves to address how commands and cells should provide the help text that is given when calling
help, and how this is then used for generating the documentation.Explain how this is achieved.
helpoptions that output rst/jsonIf applicable, please suggest to reviewers how they can test the change.
Preview build documenting page.