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

Documentation improvements #515

Merged
merged 2 commits into from Dec 14, 2015

Conversation

Projects
None yet
3 participants
@mrkkrp
Contributor

mrkkrp commented Dec 10, 2015

These include the following changes:

  • Minor cosmetics: every line should not exceed 80 column, majority of descriptions start with capital letter and end with a full stop. For consistency all descriptions should be written this way.
  • Typo corrections. There are a couple of them.
  • Added new doc-strings where they were missing.
  • Use proper and consistent Haddock syntax everywhere. In a couple of places it makes code examples readable. See (||.) for example.
  • Minor refactoring. This is not the main aim of this PR, but I changed a couple of lines when GHC and HLint asked me to do so.

This PR is WIP. I need your help. Please propose descriptions for limitOffsetOrder and getPersistMap. If you think some changes are unnecessary, tell me.

mrkkrp added some commits Dec 10, 2015

Capitalize some words in ‘development.md’
This way the style matches the rest of the document.
A bunch of documentation improvements
These include the following changes:

* Minor cosmetics: every line should not exceed 80 column, majority of
  descriptions start with capital letter and end with a full stop. For
  consistency all descriptions should be written this way.

* Typo corrections. There are a couple of them.

* Added new doc-strings where they were missing.

* Use proper and consistent Haddock syntax everywhere. In a couple of
  places it makes code examples readable. See (||.) for example.

* Minor refactoring. This is not the main aim of this PR, but I changed
  a couple of lines when GHC and HLint asked me to do so.

snoyberg added a commit that referenced this pull request Dec 14, 2015

@snoyberg snoyberg merged commit 0174487 into yesodweb:master Dec 14, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@snoyberg

This comment has been minimized.

Show comment
Hide comment
@snoyberg

snoyberg Dec 14, 2015

Member

Thanks!

Member

snoyberg commented Dec 14, 2015

Thanks!

snoyberg added a commit that referenced this pull request Dec 14, 2015

@gregwebs

This comment has been minimized.

Show comment
Hide comment
@gregwebs

gregwebs Dec 15, 2015

Member

Thank you!

Member

gregwebs commented Dec 15, 2015

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment