Improve module Haddocks #1115
Merged
Improve module Haddocks #1115
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
|
Thanks! |
* Make module Haddocks largely consistent across Set, Map, IntSet, IntMap, Seq. * Make public module docs for each structure (e.g. Data.Map, Data.Map.Lazy, Data.Map.Strict) have similar structure and content. This means some duplication of text, but there is no way to avoid it. * Trim down internal module Haddocks (e.g. Data.Map.Internal) to a structure description and references. There is no need to repeat everything that's in the public module. * Add a few lines about the complexity of common operations on each set and map structure. In particular, union and intersection are mentioned with a clear description of 'm' and 'n', to reduce the chances that a reader assumes them to be tied to positions and not sizes.
meooow25
force-pushed
the
module-docs
branch
from
1b6eaa8 to
a38a597
Compare
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.
(The last bit is motivated by #1110 (comment))