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

Add more complete documentation #25

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Add more complete documentation #25

merged 1 commit into from
Jul 19, 2024

Conversation

thomas-touhey
Copy link
Contributor

@thomas-touhey thomas-touhey commented Jul 18, 2024

Hopefully that's good enough. :)

Closes: #18

@jepler
Copy link
Owner

jepler commented Jul 19, 2024

Thank you! I really appreciate this, it's a non-trivial amount of effort you've made. I do have some feedback which I hope is not too nit-picky.

In several places you use the term "semester", for instance stating that a leap second can occur "at the end of the semester". To me this is unusual usage (as a speaker of American English, "semester" is usually used to refer to school terms, in which case it rarely corresponds to 6 months. For instance when I was a kid, the "fall semester" of the city schools would run from when school started in early September until early January for some reason).

If it is usual usage for talking about leap seconds in English I'm happy to leave it, but for instance the word "semester" doesn't appear in the english language wikipedia page https://en.wikipedia.org/wiki/Leap_second —so I'm guessing it's something that feels natural in French but doesn't quite come over right to (American) English. If you don't mind, can you just say "every six months" for the frequency of the Bulletin?

As for the timing of leap seconds, now that there is documentation, I think it should stress that the leap second occurs at the end of the minute 23:59 UTC; the local time during a leap second could be (for example in parts of the US) 16:59:60 or even (if my math is right; UTC+0845 is a time zone used for part of the year in part of Australia) 08:44:60 the next day (e.g., January 1).

Thanks again, I'm excited about this addition to the docs.

@thomas-touhey
Copy link
Contributor Author

Thanks for the feedback, edits are made :)

@jepler jepler merged commit c1d1dfa into jepler:main Jul 19, 2024
11 checks passed
@jepler
Copy link
Owner

jepler commented Jul 19, 2024

Thank you!

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.

Some improvements suggested on the documentation
2 participants