Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvement request: documentation improvements #57

Open
axman6 opened this issue Mar 2, 2017 · 1 comment
Open

Improvement request: documentation improvements #57

axman6 opened this issue Mar 2, 2017 · 1 comment

Comments

@axman6
Copy link

axman6 commented Mar 2, 2017

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?)

@jml
Copy link

jml commented Mar 9, 2017

I'd also suggest adding examples to the format code so it's easy to see what output to expect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants