Documentation improvements #515
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This way the style matches the rest of the document.
mrkkrp
force-pushed
the
documentation-improvements
branch
from
92c4445
to
def9d92
Compare
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.
mrkkrp
force-pushed
the
documentation-improvements
branch
from
def9d92
to
e225e20
Compare
|
Thanks! |
snoyberg
added a commit
that referenced
this pull request
Dec 14, 2015
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These include the following changes:
(||.)for example.This PR is WIP. I need your help. Please propose descriptions for
limitOffsetOrderandgetPersistMap. If you think some changes are unnecessary, tell me.