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 Code #32

Open
jsmvaldivia opened this issue Nov 3, 2021 · 0 comments
Open

Document Code #32

jsmvaldivia opened this issue Nov 3, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@jsmvaldivia
Copy link

Considering that the code is public we should add meaningful documentation to the project.

We should add text that accompanies software code to explain what the code is doing, why it's written the way it is, and/or how to use it.

Typically we should add it to packages, exported types and exported functions.
@jsmvaldivia jsmvaldivia added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jsmvaldivia