Skip to content

Improvement request: documentation improvements #57

@axman6

Description

@axman6

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions