Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

document the api #47

Open
zsluedem opened this issue Mar 8, 2020 · 5 comments
Open

document the api #47

zsluedem opened this issue Mar 8, 2020 · 5 comments
Labels
help wanted Extra attention is needed

Comments

@zsluedem
Copy link
Collaborator

zsluedem commented Mar 8, 2020

No description provided.

@zsluedem zsluedem added the help wanted Extra attention is needed label Mar 8, 2020
@dckc
Copy link

dckc commented Sep 17, 2020

@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
Copy link

dckc commented Sep 30, 2020

@jimscarver is interested to help

@dckc
Copy link

dckc commented Sep 30, 2020

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

@zsluedem
Copy link
Collaborator Author

zsluedem commented Oct 1, 2020

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

@zsluedem
Copy link
Collaborator Author

zsluedem commented Oct 1, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dckc @zsluedem