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

Improve the documentation #52

Open
5 tasks
ValentijnvdBeek opened this issue Jan 2, 2019 · 0 comments
Open
5 tasks

Improve the documentation #52

ValentijnvdBeek opened this issue Jan 2, 2019 · 0 comments
Labels
enhancement help wanted
Projects
Porcelain

Comments

@ValentijnvdBeek
Copy link
Collaborator

Clay currently misses a few vital pieces of documentation that need to be added in the future. Preferably before the next version is released however, in my opinion, this is not a blocking issue.

The documentation that should written or modified:

  • an usage man page
  • a configuration man page
  • sphinx documentation
  • an rst version of the README for PyPy
  • improved docstrings using an unified format
@ValentijnvdBeek ValentijnvdBeek created this issue from a note in Porcelain (In progress) Jan 2, 2019
@ValentijnvdBeek ValentijnvdBeek mentioned this issue Feb 18, 2019
Draft
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
Porcelain
  
In progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ValentijnvdBeek