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

Enhance docs and add examples #31

Open
Restioson opened this issue Dec 15, 2017 · 3 comments
Open

Enhance docs and add examples #31

Restioson opened this issue Dec 15, 2017 · 3 comments
Labels
good-first-issue housekeeping

Comments

@Restioson
Copy link
Member

Restioson commented Dec 15, 2017 •
edited
Loading

We should rewrite docs for existing code, adding it where there is none, and add examples. Even private functions should be documented -- this is so that contributors will be able to easily find out how to use something.
@Gegy
Copy link
Member

Gegy commented Dec 15, 2017 •
edited
Loading

Maybe a bit out of context, but should relate. Should we make a contributing doc for anyone (and ourselves) who needs to review this project's coding standards?

@Restioson
Copy link
Member Author

Restioson commented Dec 15, 2017 •
edited
Loading

Is kinda out of context, but yes. Issue opened (#32)

@Restioson
Copy link
Member Author

Going forward from now, let's write docs and examples on non trivial functions (not getters and really simple things). @gegy1000, agree or disagree?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good-first-issue housekeeping
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Gegy @Restioson