style-guide: Add chapter for nightly formatting

Co-authored-by: Michael Goulet <michael@errs.io>
This commit is contained in:
Josh Triplett 2023-06-21 17:08:42 -07:00 committed by Michael Goulet
parent 5a6c618d1a
commit 5957f028a1

View File

@ -1,3 +1,5 @@
The style guide does not prescribe formatting for nightly-only syntax. Refer to
the style team policy for nightly formatting procedure regarding breaking
formatter changes and feature stabilization.
This chapter documents style and formatting for nightly-only syntax. The rest of the style guide documents style for stable Rust syntax; nightly syntax only appears in this chapter. Each section here includes the name of the feature gate, so that searches (e.g. `git grep`) for a nightly feature in the Rust repository also turn up the style guide section.
Style and formatting for nightly-only syntax should be removed from this chapter and integrated into the appropriate sections of the style guide at the time of stabilization.
There is no guarantee of the stability of this chapter in contrast to the rest of the style guide. Refer to the style team policy for nightly formatting procedure regarding breaking changes to this chapter.