Information about data structures
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the package's existing Data.Set and other data-structure documentation, using the linked Data.HashMap docs as the comparison point. Record each structure's purpose and stated properties, including uniqueness for Data.Set. The work is done when the package documentation explains these points consistently.
Written by the indexing model from the issue text.
Description
As an example of another module Data.HashMap it says
Note that this is an unordered collection.
https://pursuit.purescript.org/packages/purescript-unordered-collections/1.0.1/docs/Data.HashMap
Such information would also be useful for the data structures in this package
About Data.Set i would guess that it has a uniqueness property because
All the elements in a set are unique.
http://learnyouahaskell.com/modules and because of the similarities between haskell and purescript
But the documentation of purescript's Data.Set doesn't specify this.
Can some information be added to the data structures in the package what they are for and which properties they offer?
- Dominant language
- PureScript
- Stars
- 38
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from purescript/purescript-ordered-collections
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
purescript/purescript-ordered-collections#70 · 2 comments ·
-
Add non-empty `Map` Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
purs-0.17 type: breaking change
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
purs-0.16 type: breaking change
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
All issues in purescript/purescript-ordered-collections
Similar issues
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
-
Перевод устарел
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
-
affects/8.7 affects/8.8 affects/8.9
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
camunda/camunda-docs#9997 ·
-
Website Doc Typo Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100