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

fix: Fix the JSDoc comments on the TZDate and TZDateMini classes #26

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

csandman
Copy link

I just noticed that the doc comment on the TZDate class (in the .js file) is still the UTCDate, which I assume it was forked from. However, I also noticed that the correct comment was on the declaration file for the class, so I just replaced the one on the JS class with the other one.

I also noticed that there was no doc comment on the TZDateMini class, so I copied that one as well.

Alternatively, maybe you actually don't want to include them at all on the JS file versions? I'm not really sure how they interact if someone is using a non-typescript project. So if you'd rather have me remove both of them, I can update it to that instead. I just figured a correct doc comment was better than an incorrect one haha.

@kossnocorp
Copy link
Member

Hey, thank you! I think you're right about not needing to include them. It's better to get rid of them so when I update docs, I don't forget to update the copy. The same problem is in the UTC repo, too. If you want, you can send a PR there, too: https://github.com/date-fns/utc/blob/main/src/date/index.js#L3-L15. Or let me know, and I'll remove it there myself.

@csandman
Copy link
Author

Hey, thank you! I think you're right about not needing to include them. It's better to get rid of them so when I update docs, I don't forget to update the copy. The same problem is in the UTC repo, too. If you want, you can send a PR there, too: date-fns/utc@main/src/date/index.js#L3-L15. Or let me know, and I'll remove it there myself.

Gotcha, I just removed them!

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

Successfully merging this pull request may close these issues.

2 participants