std.time.epoch: API naming fixes and clean-ups #24176
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wooster0
force-pushed
the
epoch
branch
2 times, most recently
from
8b0f3f2 to
e9e11db
Compare
- Use consistent date format in documentation comments. - Deprecate `epoch_year`: if anything it should be called `year` (though that's difficult due to aliasing) but I couldn't find anyone using this constant and I don't see how it would be useful unless you want to do time calculation on your own, but you can instead just use the functions provided by the structure. - Deprecate `secs_per_day`: this already exists in `std.time`. - Remove all `@as` in the file. All were unnecessary. - Fix bad naming of structure names and fields. `YearAndDay` sounds like it's the year of the time and the day of the time, when actually it is the year o the time and the number of the days into the day, so that should definitely be plural. - Fix redundant words in names. The entire file concerns itself with the Unix epoch so no need to repeat that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
epoch_year: if anything it should be calledyear(though that's difficult due to aliasing) but I couldn't find anyone
using this constant and I don't see how it would be useful unless you
want to do time calculation on your own, but you can instead
just use the functions provided by the structure.
secs_per_day: this already exists instd.time.@asin the file. All were unnecessary.YearAndDaysounds like it's the year of the time and the day of thetime, when actually it is the year of the time and the number of the
days into the day, so that should definitely be plural.
Unix epoch so no need to repeat that.