Merged
Conversation
179bd29 to
de46ff9
Compare
vrom911
reviewed
Jul 5, 2019
README.md
Outdated
| + Tutorial | ||
| + Migration guide from `Prelude` | ||
| + Haddock for every function with examples tested by [`doctest`](http://hackage.haskell.org/package/doctest) | ||
| + Documentation regarding [internal module structure](http://hackage.haskell.org/package/relude/docs/Relude.html) |
README.md
Outdated
| source file of your project. If you want to use some data types or functions | ||
| which are not exposed by `Prelude`, you need to import them, adding necessary | ||
| libraries to your project dependencies. Unlike ordinary libraries, alternative | ||
| preludes replace default functions and data types. |
Member
There was a problem hiding this comment.
"Replace functions and data types" could sound a bit scary when interpreted incorrectly... Probably somehow rephrase this?
README.md
Outdated
|
|
||
| ### base | ||
|
|
||
| Multiple sorting functions are available without imports: |
Member
There was a problem hiding this comment.
without imports? probably this is an unnecessary phrase?
Contributor
Author
There was a problem hiding this comment.
I just copy-pasted this part. But I agree that part about imports in redundant in the context of preludes. Thanks for noticing!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've noticed that README can be improved in several ways. Let me know what do you think.