This repository has been archived by the owner on Jan 13, 2023. It is now read-only.
docs: add Basic Concepts page
#269
Merged
Conversation
This file contains 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 20, 2019
docs/basic_concepts.rst
Outdated
Comment on lines
137
to
138
| Transactions in the bundle are linked together through their ``branchTransaction`` | ||
| and ``trunkTransaction`` fields, furthermore they are indexed within the bundle |
There was a problem hiding this comment.
❕ I believe the client libraries rely exclusively on trunkTransaction to link bundle transactions together; as far as I'm aware, branchTransaction does not have any function beyond confirming a second tip.
There was a problem hiding this comment.
You are right. What do you think about including such a picture to illustrate this?
There was a problem hiding this comment.
Ooh, ya, that looks good!
| Before diving into the API, it's important to understand the fundamental | ||
| data types of IOTA. | ||
|
|
||
| :todo: Link to IOTA docs |
There was a problem hiding this comment.
😹 omg how long has that been there??
There was a problem hiding this comment.
little more than 2 years 😸
lzpap
force-pushed
the
docs_basic_concepts
branch
from
6470a5c to
c1b4dcd
Compare
Add a page describing basic IOTA concepts with references to the official docs site.
lzpap
force-pushed
the
docs_basic_concepts
branch
from
c1b4dcd to
16226e8
Compare
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
Basic ConceptsfromPyOTA Types.Internal links to PyOTA classes and methods point to parts of the documentation that will be updated in future commits.