This repository was archived by the owner on Jan 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 126
docs: re-write PyOTA types page #270
Merged
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
todofixthis
approved these changes
Nov 26, 2019
Contributor
todofixthis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with questions/suggestions 😺
| (``currentIndex``, ``lastIndex``) fields. Head of the bundle has index 0, | ||
| while tail has index 3. | ||
| (``currentIndex``, ``lastIndex``) fields. Head of the bundle has index 3, | ||
| while tail has index 0. |
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🏻 Good catch!
3a5bd06 to
e7afcf8
Compare
- complete rewerite of types.rst - Add/extend/polish docstrings for several type classes - small correction in basic_concepts.rst
e7afcf8 to
fb73a86
Compare
todofixthis
approved these changes
Dec 2, 2019
Contributor
todofixthis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🎉
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 issue #268
Changes
types.rstbasic_concepts.rstPyOTA typesin its current form presents the data types that a regular user of the library is interested in to generate seeds, addresses, transactions, bundles, etc.It might be beneficial to include an additional page in the future
Advanced PyOTA Data Typesthat is intended towards people who do development on the lib. Right now the entry barrier to development seems to be quite high due to lack of proper introduction and in-depth documentation.