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

Add first tutorials to documentation #287

Merged
merged 4 commits into from
Jan 15, 2020
Merged

Conversation

lzpap
Copy link
Member

@lzpap lzpap commented Jan 14, 2020

Related: #268 and #284

Description

Open a new section Tutorials in PyOTA documentation that will be home to detailed examples of tasks that could be carried out with the help of the library.

Proposed structure of the section:

  • Full code example first,
  • followed by a detailed, step-by-step code walk through.

Also, refer to other sections in the documentation while describing your code to help others develop their knowledge. If you notice that something is missing, improve it. (like this PR does for TryteString.random().)

Added two basic scenarios that might be helpful to IOTA and Python newcomers:

  • Hello Node and
  • Send Data

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.

Looks good! Minor suggestions 😺

docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Show resolved Hide resolved
Copy link
Member Author

@lzpap lzpap left a comment

Choose a reason for hiding this comment

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

thanks for the remarks @todofixthis !

docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
docs/tutorials.rst Outdated Show resolved Hide resolved
@lzpap lzpap merged commit 5a3aecd into iotaledger:develop Jan 15, 2020
@lzpap lzpap deleted the tutorials_init branch January 28, 2020 10:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants