diff options
| author | bors <bors@rust-lang.org> | 2023-09-19 18:52:10 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2023-09-19 18:52:10 +0000 |
| commit | ac5ac4754a4a837f7138a1fa5ab01475b63fc9fe (patch) | |
| tree | 8d4ed7161ccfe6c3121efe178f6336f1bf515079 /src/doc | |
| parent | 42f5828b01817e2aa67458c0c50db0b1c240f0bd (diff) | |
| parent | 1b862186a78a2718cf9e644a647e5ff7288a4149 (diff) | |
| download | rust-ac5ac4754a4a837f7138a1fa5ab01475b63fc9fe.tar.gz rust-ac5ac4754a4a837f7138a1fa5ab01475b63fc9fe.zip | |
Auto merge of #115979 - GuillaumeGomez:rollup-06ujzgh, r=GuillaumeGomez
Rollup of 6 pull requests Successful merges: - #113383 (style-guide: Add section on bugs, and resolving bugs) - #115499 (rustc_target/riscv: Fix passing of transparent unions with only one non-ZST member) - #115801 (Detect cycle errors hidden by opaques during monomorphization) - #115947 (Custom code classes in docs warning) - #115957 (fix mismatched symbols) - #115958 (explain mysterious addition in float minimum/maximum) r? `@ghost` `@rustbot` modify labels: rollup
Diffstat (limited to 'src/doc')
| -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 |