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.

Sign up for GitHub

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

Jump to bottom

RustDocs for SystemTime and Instant should note that their Add<Duration> implementations panic #71226

Closed
woody77 opened this issue Apr 16, 2020 · 1 comment · Fixed by #76388
Closed

RustDocs for SystemTime and Instant should note that their Add<Duration> implementations panic #71226

woody77 opened this issue Apr 16, 2020 · 1 comment · Fixed by #76388
Assignees
@poliorcetics
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@woody77
Copy link

woody77 commented Apr 16, 2020 •
edited by rustbot
Loading

This note: https://doc.rust-lang.org/std/time/struct.SystemTime.html#panics is too deeply buried in the documentation.

Proposal:

Put a note after the underlying syscalls section in the overall struct documentation that math operations on SystemTime (and Instant) can panic.
@jonas-schievink jonas-schievink added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Apr 16, 2020
@Mark-Simulacrum Mark-Simulacrum added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Apr 16, 2020
@poliorcetics
Copy link
Contributor

@rustbot claim

@poliorcetics poliorcetics mentioned this issue Sep 5, 2020
Merged
@bors bors closed this as completed in 59476e9 Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@poliorcetics poliorcetics

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add a note about the panic behavior of math operations on time objects poliorcetics/rust
4 participants
@jonas-schievink @Mark-Simulacrum @poliorcetics @woody77