document the api - Githubissues

rchain / pyrchain

Python 3 interface to RChain RNode RPC

GNU General Public License v3.0

10 stars 10 forks source link

document the api #47

Open zsluedem opened 4 years ago

dckc commented 4 years ago

@jimscarver writes:

https://github.com/rchain/pyrchain/blob/master/README.md needs examples to be tested and reference in rholang.org for python develper. -- https://discord.com/channels/375365542359465989/748967102840569886/755419661624934520

The upcoming hackathon provides particular motivation.

dckc commented 4 years ago

@jimscarver is interested to help

dckc commented 4 years ago

on second thought, @TheoXD and I are content with the current documentation.

zsluedem commented 4 years ago

https://wiki.python.org/moin/DocumentationTools tools for document python api

zsluedem commented 4 years ago

Maybe https://github.com/pdoc3/pdoc is better because it support for PEP 484 and PEP 526 type annotations.