Improvement request: documentation improvements
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- haskell
- Domain
- documentation
Research direction
Start in the Data.Thyme.Time.Core module and inventory the undocumented functions, beginning with dayOfYearToMonthAndDay and the addGregorianYearsClip/addGregorianYearsRollover pair. Read their implementations to determine the meaning of each parameter and the behavioral distinction, then document those contracts and verify the project still builds.
Written by the indexing model from the issue text.
Description
Many of the functions in at least Data.Thyme.Time.Core lack any documentation, for example
dayOfYearToMonthAndDay :: Bool -> DayOfYear -> (Month, DayOfMonth)
gives no guidance to what the Bool represents (it's only when looking at the code that you find it specified if the DayOfYear is part of a leap year). In many cases it's pretty clear what the meaning is, but when both
addGregorianYearsClip :: Years -> Day -> Day
and
addGregorianYearsRollover :: Years -> Day -> Day
exist, some documentation is needed to explain exactly what the difference is (what is being clipped or rolled over? Is this also for the case where you're adding years spanning a leap year?)
- Dominant language
- Haskell
- Stars
- 47
- Forks
- 35
- 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 haskell-github-trust/thyme
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
haskell-github-trust/thyme#82 · 1 comment ·
-
Dependency Dashboard Open
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
All issues in haskell-github-trust/thyme
Similar issues
-
time-manager-0.4.0 Openfailure: bounds
Difficulty 1/5 Under an hour Newbie friendliness 72/100
commercialhaskell/stackage#8122 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
simplex-chat/simplex-chat#7547 ·
-
chore
Difficulty 1/5 Under an hour Newbie friendliness 90/100
alunduil/alunduil-chezmoi#775 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
objectionary/phino#1350 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100