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

Add documentation to the HTML module #3683

Merged
merged 1 commit into from
Dec 13, 2016

Conversation

dylandrop
Copy link
Contributor

Title says it all. Add documentation where it is needed.

Copy link
Member

@bcardiff bcardiff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs should have some basic example when possible. escape(String) : String and unescape(String) : String are simple enough to add some of them. The IO version can refer to the previous one.

You can find style/inspiration in string.cr .

They don't need to be exhaustive, but representative.

@dylandrop dylandrop force-pushed the add-documentation-to-html branch from fdcef7d to 46913cf Compare December 13, 2016 01:45
@dylandrop
Copy link
Contributor Author

@bcardiff No problem -- updated.

@dylandrop dylandrop force-pushed the add-documentation-to-html branch from 46913cf to ddae827 Compare December 13, 2016 05:08
@asterite
Copy link
Member

Looks good now, thank you!

@asterite asterite merged commit 51e2e76 into crystal-lang:master Dec 13, 2016
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

Successfully merging this pull request may close these issues.

3 participants