Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

docs: re-write PyOTA types page #270

Merged
merged 2 commits into from
Dec 2, 2019
Merged

Conversation

lzpap
Copy link
Member

@lzpap lzpap commented Nov 26, 2019

Related issue #268

Changes

  • Complete rewerite of types.rst
  • Add/extend/polish docstrings for several type classes
  • Small correction in basic_concepts.rst

PyOTA types in 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 Types that 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.

Copy link
Contributor

@todofixthis todofixthis left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻 Good catch!

docs/types.rst Show resolved Hide resolved
docs/types.rst Show resolved Hide resolved
docs/types.rst Outdated Show resolved Hide resolved
docs/types.rst Outdated Show resolved Hide resolved
iota/transaction/creation.py Outdated Show resolved Hide resolved
iota/types.py Outdated Show resolved Hide resolved
iota/types.py Outdated Show resolved Hide resolved
iota/types.py Outdated Show resolved Hide resolved
iota/types.py Outdated Show resolved Hide resolved
 - complete rewerite of types.rst
 - Add/extend/polish docstrings for several type classes
 - small correction in basic_concepts.rst
Copy link
Contributor

@todofixthis todofixthis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🎉

@lzpap lzpap merged commit 28c249b into iotaledger:develop Dec 2, 2019
@lzpap lzpap deleted the docs_pyota_types branch January 28, 2020 10:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants