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

Improve Documentation #269

Open
jdsandifer opened this issue Feb 6, 2024 · 3 comments
Open

Improve Documentation #269

jdsandifer opened this issue Feb 6, 2024 · 3 comments

Comments

@jdsandifer
Copy link

jdsandifer commented Feb 6, 2024

Based on my own experience of using the library and seeing many of the open and closed issues, it seems like it is common for people to use this library without fully understanding the intention of some of its functions.

This isn't a fault of the current documentation; when read completely and with consideration for the behavior of Dates in JS in general, it's clear what each function is intended to achieve.

However, I believe it's common to use libraries like date-fns and date-fns-tz to avoid the many tricky parts of working with dates and learning about them so I think some changes to the documentation to help educate users about Dates and how this library's functions work with them could be useful.

In addition, whether because of habit or time pressure, many devs probably aren't reading the full documentation and simply jumping to the function that they need to understand. (I know I did that the first few times.) I believe some duplication of important concepts would help each function's documentation be more complete and understandable on its own - the way it's probably most often consumed.

@jdsandifer
Copy link
Author

@marnusw If this issue sounds reasonable, I'd be happy to open a PR with some of the ideas I had.

@toduyemi
Copy link

toduyemi commented Apr 2, 2024

This would be really nice. The documentation does nothing to describe the formatting of its API. E.g. Whether parameters are in seconds or milliseconds.

@marnusw
Copy link
Owner

marnusw commented Apr 3, 2024

@jdsandifer thank you for the offer. I would welcome improvements to the documentation!

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

3 participants