Docs update #51
Merged
Docs update #51
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
MichaelAldrich
commented
Jan 8, 2021
Comment on lines
+6
to
+15
| Welcome to the nxt api documentation! | ||
| ===================================== | ||
|
|
||
| The content within this documentation is the "public" api, what nxt's version numbers are constrained to. | ||
|
|
||
| These documents represent the supported parts of the api. More pieces | ||
| will be documented as python ergonomics improve. | ||
| In the source there are many more classes, methods, and even a few modules not | ||
| listed here. | ||
| Any use of those methods is at your own risk. |
There was a problem hiding this comment.
Source of the homepage, most valuable text to review
MichaelAldrich
commented
Jan 8, 2021
Comment on lines
+99
to
+100
| if token_types is None: | ||
| token_types = TOKENTYPE.ALL |
There was a problem hiding this comment.
A code change that snuck in. I made this change in order to clean up the messy argument expansion sphinx was doing with TOKENTYPE.ALL as the default kwarg value. Not my favorite change ever.
There was a problem hiding this comment.
Hmmm its fine I guess. I know we use defaults like that in a few other places, I really don't want to have to change all those other signatures like this.
…ths for new split repos
MichaelAldrich
force-pushed
the
docs_updates
branch
from
5a5a4eb to
a63d889
Compare
ImLucasBrown
approved these changes
Jan 8, 2021
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.
Cleanup from repo splits.
Update docs build.
Lots of doc strings