From 5957f028a1019f306b131299e6e653d942f809e9 Mon Sep 17 00:00:00 2001 From: Josh Triplett Date: Wed, 21 Jun 2023 17:08:42 -0700 Subject: [PATCH] style-guide: Add chapter for nightly formatting Co-authored-by: Michael Goulet --- src/doc/style-guide/src/nightly.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/doc/style-guide/src/nightly.md b/src/doc/style-guide/src/nightly.md index 5a2815c71f1..031811b0e6f 100644 --- a/src/doc/style-guide/src/nightly.md +++ b/src/doc/style-guide/src/nightly.md @@ -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.