date-fns / date-fns

⏳ Modern JavaScript date utility library ⌛️
https://date-fns.org
MIT License
34.1k stars 1.76k forks source link

Clarify in isWeekend days #3757

Open adrianjost opened 2 months ago

adrianjost commented 2 months ago

There is an issue with the isWeekend documentation

The problem with isWeekend documentation

It's not clear how "weekend" is defined. In some companies, Saturday is a working day, so not strictly speaking a weekend for all persons. This is also seen in https://github.com/date-fns/date-fns/issues/2085.

Suggested edits

I would suggest adding the information that Saturday and Sunday are considered weekend days and those are the only ones checked in this utility.

zapha commented 1 month ago

@kossnocorp, can I work on this issue?