Skip to content

Commit

Permalink
Rollup merge of #111119 - compiler-errors:style-nightly, r=joshtriplett
Browse files Browse the repository at this point in the history
style-guide: Add chapter about formatting for nightly-only syntax

cc `@rust-lang/style`

nightly policy mentioned below is being proposed in rust-lang/style-team#180
  • Loading branch information
fee1-dead authored Jul 6, 2023
2 parents d9c13cd + 5957f02 commit 6e9bdac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/doc/style-guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
- [Other style advice](advice.md)
- [`Cargo.toml` conventions](cargo.md)
- [Guiding principles and rationale](principles.md)
- [Nightly-only syntax](nightly.md)
5 changes: 5 additions & 0 deletions src/doc/style-guide/src/nightly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
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.

0 comments on commit 6e9bdac

Please sign in to comment.