diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2023-09-19 20:23:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-19 20:23:18 +0200 |
| commit | 7a27acfdbb1dc2f151f40717ccbdc1cda2dc6159 (patch) | |
| tree | 2f267556cce9f2a506c9fdd1ef6dc9439de7c6a7 | |
| parent | 0692db1a9082380e027f354912229dfd6af37e78 (diff) | |
| parent | 08a997eea28c75e23e5b765de1578c8537ac16bf (diff) | |
| download | rust-7a27acfdbb1dc2f151f40717ccbdc1cda2dc6159.tar.gz rust-7a27acfdbb1dc2f151f40717ccbdc1cda2dc6159.zip | |
Rollup merge of #113383 - joshtriplett:style-bugs, r=compiler-errors
style-guide: Add section on bugs, and resolving bugs
| -rw-r--r-- | src/doc/style-guide/src/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/doc/style-guide/src/README.md b/src/doc/style-guide/src/README.md index f4d75967370..9a59d80556e 100644 --- a/src/doc/style-guide/src/README.md +++ b/src/doc/style-guide/src/README.md @@ -32,6 +32,19 @@ This should not be interpreted as forbidding developers from following a non-default style, or forbidding tools from adding any particular configuration options. +## Bugs + +If the style guide differs from rustfmt, that may represent a bug in rustfmt, +or a bug in the style guide; either way, please report it to the style team or +the rustfmt team or both, for investigation and fix. + +If implementing a new formatting tool based on the style guide and default Rust +style, please test it on the corpus of existing Rust code, and avoid causing +widespread breakage. The implementation and testing of such a tool may surface +bugs in either the style guide or rustfmt, as well as bugs in the tool itself. + +We typically resolve bugs in a fashion that avoids widespread breakage. + ## Formatting conventions ### Indentation and line width |