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

Provide inline documentation of functions #57

Open
machawk1 opened this issue Dec 7, 2016 · 1 comment
Open

Provide inline documentation of functions #57

machawk1 opened this issue Dec 7, 2016 · 1 comment
Labels
Code/Project quality enhancement
Milestone
1.0 (Fundamental ...

Comments

@machawk1
Copy link
Member

machawk1 commented Dec 7, 2016

See https://github.com/ipfs/py-ipfs-api/blob/78821ef6037c0577a227a475efbde4eac20528a3/ipfsapi/client.py as a style example.
@machawk1 machawk1 added this to the 1.0 milestone Dec 7, 2016
@machawk1 machawk1 changed the title Functions need inline documenting Provide inline documentation of functions Dec 7, 2016
@machawk1
Copy link
Member Author

machawk1 commented Mar 1, 2017 •
edited
Loading

Use Sphinx and ReadTheDocs once defined to generate docs based on comments in code.

machawk1 added a commit that referenced this issue Dec 13, 2017
@machawk1
Doc doc goose for #57
574d8ae
@machawk1 machawk1 mentioned this issue Dec 13, 2017
Merged
machawk1 added a commit that referenced this issue Dec 13, 2017
@machawk1
Merge pull request #329 from oduwsdl/issue-57
fe67d4f 
Doc doc goose for #57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Code/Project quality enhancement
Projects
None yet
Milestone
1.0 (Fundamental Features)
Development

No branches or pull requests
1 participant
@machawk1