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

Write documentation for the Termination trait #740

Closed

Conversation

LeSeulArtichaut
Copy link

This PR adds documentation for the Termination trait proposed in rust-lang/rfcs#1937.
See tracking issue rust-lang/rust#43301.

@ehuss
Copy link
Contributor

ehuss commented Jan 27, 2020

Thanks for the PR! Can you say more why you'd like to add this? The reference doesn't generally include content on unstable features, so I'm not sure if this should be included (it already has a brief link here). The reference also generally doesn't include details about how the standard library is implemented, and instead focuses on just the language itself.

@LeSeulArtichaut
Copy link
Author

I thought this was part of the stabilization process. If you look at the tracking issue, the only missing step is « adjust documentation »

@ehuss
Copy link
Contributor

ehuss commented Jan 29, 2020

Ah, is there a proposal to stabilize it somewhere?

Generally, stabilization isn't usually gated on having the reference updated. Since the reference only covers stable language features, it's usually best to update it during the stabilization process, or shortly afterwards.

As for this specific change, I'm not sure what the best way to document this is. As I understand, Termination is not a language feature, since it is implemented solely in the standard library (using the unstable start lang item). I would probably just update the note in the "Main Functions" section, and leave only the first paragraph from this PR in the special traits list. The details of how Termination is implemented is up to the standard library, and seems like the kind of thing that is not relevant to the language, and very difficult to keep in sync. It could then be updated or removed if/when start is stabilized.

@LeSeulArtichaut
Copy link
Author

Alright, closing this

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.

2 participants