fix: Fix the JSDoc comments on the TZDate
and TZDateMini
classes
#26
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I just noticed that the doc comment on the
TZDate
class (in the .js file) is still theUTCDate
, 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.