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.

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

Sparse Documentation: node module #75

Open
garbagetrash opened this issue Feb 16, 2019 · 1 comment
Open

Sparse Documentation: node module #75

garbagetrash opened this issue Feb 16, 2019 · 1 comment
Assignees

Comments

@garbagetrash
Copy link
Collaborator

Update documentation for the node module. In particular:

  • Add single line descriptions where missing, and extended descriptions where necessary
  • Add arguments sections where missing
  • Add examples sections where missing
  • Ensure all docs tests are passing

Use the util module documentation (or better) as a target for level of completeness.

@garbagetrash
Copy link
Collaborator Author

Probably not much for you to do on this one since there aren't too many pieces to be documented, but I figured it'd be best for you to look at it rather than me since you know the guts so much better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants