Termination documentation should describe only the standard library runtime's use of Termination #93448
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.
E-easy
Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
E-help-wanted
Call for participation: Help is requested to fix this issue.
T-libs-api
Relevant to the library API team, which will review and decide on the PR/issue.
Comments
yaahc
added
E-easy
lcnr
changed the title
|
@rustbot claim |
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this issue
Mar 22, 2022
… r=yaahc update Termination trait docs this pr add some statement about intending to provide `Termination` trait only on standard library's runtime. from rust-lang#93448 r? `@Lokathor`
Enselic
added
A-docs
|
Closing this as it's solved by #95207 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The docs for the Termination are currently a little light. When the docs are expanded/updated as part of the stabilization the likely path forward is that they'll describe that a Termination returned from
mainwill print any errors and then usestd::process::exitto end the program.When the Termination docs are expanded, we should be sure to maintain clearly that what the standard library's runtime does is not a hard requirement on what other runtimes must do with the Termination data. Particularly, a no_std binary being run on an embedded system does not necessarily have anywhere to print, and it certainly can't call the specific function
std::process::exit.The text was updated successfully, but these errors were encountered: