I come from Elm. I find its API documentation helpful because the more common functions are at the beginning.
I'm not criticizing! I want to help!
Here's the first 5 documented functions from Dict:
Build (major category)
- empty
- singleton
- update
- insert
- remove
Here are the first 5 from Data.Map:
- showTree
- empty
- isEmpty
- singleton
- checkValue
I think the Elm API documentation is better. checkValue is not important. When i want to look for a function, I find it faster in the Elm documentation.
Elm has the advantage that their doc format lets you categorize. Still, I think Data.Map API documentation could be improved with better organization. People who haven't memorized the key parts of the API want to know whether the "add a new element" function is add or insert without having to scroll past lookupLt, lookupGE, lookupGT, findSubMap, and subMap.
I volunteer to reorganize the functions in the source to put the more common ones first, if someone says they'd accept such a pull request.
I come from Elm. I find its API documentation helpful because the more common functions are at the beginning.
I'm not criticizing! I want to help!
Here's the first 5 documented functions from
Dict:Here are the first 5 from
Data.Map:I think the Elm API documentation is better.
checkValueis not important. When i want to look for a function, I find it faster in the Elm documentation.Elm has the advantage that their doc format lets you categorize. Still, I think
Data.MapAPI documentation could be improved with better organization. People who haven't memorized the key parts of the API want to know whether the "add a new element" function isaddorinsertwithout having to scroll pastlookupLt,lookupGE,lookupGT,findSubMap, andsubMap.I volunteer to reorganize the functions in the source to put the more common ones first, if someone says they'd accept such a pull request.