Document how to mark features as incomplete (#1151)

* Document how to mark features as incomplete

This was changed in https://github.com/rust-lang/rust/pull/86446 so that
incompleteness is included in the delcaration.

* Footerify link
This commit is contained in:
Smittyvb 2021-06-29 12:41:13 -04:00 committed by GitHub
parent 48d01f867d
commit c319110e8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions

View File

@ -27,6 +27,14 @@ For example:
(active, non_ascii_idents, "1.0.0", Some(55467), None), (active, non_ascii_idents, "1.0.0", Some(55467), None),
``` ```
Features can be marked as incomplete, and trigger the warn-by-default [`incomplete_features` lint]
by setting their type to `incomplete`:
```rust,ignore
/// Allows unsized rvalues at arguments and parameters.
(incomplete, unsized_locals, "1.30.0", Some(48055), None),
```
When added, the current version should be the one for the current nightly. When added, the current version should be the one for the current nightly.
Once the feature is moved to `accepted.rs`, the version is changed to that Once the feature is moved to `accepted.rs`, the version is changed to that
nightly version. nightly version.
@ -99,4 +107,5 @@ updating the declaration!
["Stability in code"]: ./implementing_new_features.md#stability-in-code ["Stability in code"]: ./implementing_new_features.md#stability-in-code
[`incomplete_features` lint]: https://doc.rust-lang.org/rustc/lints/listing/warn-by-default.html#incomplete-features
["Updating the feature-gate listing"]: ./stabilization_guide.md#updating-the-feature-gate-listing ["Updating the feature-gate listing"]: ./stabilization_guide.md#updating-the-feature-gate-listing