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

Add Top Level documentation to all public types #85

Open
brentleyjones opened this issue Aug 11, 2015 · 3 comments
Open

Add Top Level documentation to all public types #85

brentleyjones opened this issue Aug 11, 2015 · 3 comments
Labels
easy contribution enhancement help wanted

Comments

@brentleyjones
Copy link
Member

No description provided.

@JonathanHoffman
Copy link
Contributor

What do you have in mind for this? Sections or pages in a playground? New doc file? Github wiki?

@brentleyjones
Copy link
Member Author

The /// An imaginary die but for all public types. Docstrings for all public types. Another issue will be for all public properties. Another will be for all public methods. Another will be for all public functions 😄.

@JonathanHoffman
Copy link
Contributor

Oh I see. I've been thinking about how certain code can be made easier to understand with comments and docstrings.

@LoganJohnson LoganJohnson self-assigned this Oct 12, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easy contribution enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@brentleyjones @LoganJohnson @JonathanHoffman