bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Update documentation to the dev fmt command

Browse source
This commit is contained in:
flip1995 2019-07-04 14:35:27 +02:00
parent 0c00391ed0
commit 3977843ab5
No known key found for this signature in database
GPG key ID: 01C836B640FFDFB1
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/adding_lints.md
View file

@ -345,16 +345,18 @@ list][lint_list].
### Running rustfmt ### Running rustfmt
[Rustfmt](https://github.com/rust-lang/rustfmt) is a tool for formatting Rust code according [Rustfmt](https://github.com/rust-lang/rustfmt) is a tool for formatting Rust
to style guidelines. Your code has to be formatted by `rustfmt` before a PR can be merged. code according to style guidelines. Your code has to be formatted by `rustfmt`
before a PR can be merged. Clippy uses nightly `rustfmt` in the CI.
It can be installed via `rustup`: It can be installed via `rustup`:
```bash ```bash
rustup component add rustfmt rustup component add rustfmt --toolchain=nightly
``` ```
Use `cargo fmt --all` to format the whole codebase. Use `./util/dev fmt` to format the whole codebase. Make sure that `rustfmt` is
installed for the nightly toolchain.
### Debugging ### Debugging
@ -371,7 +373,7 @@ Before submitting your PR make sure you followed all of the basic requirements:
- [ ] `cargo test` passes locally - [ ] `cargo test` passes locally
- [ ] Executed `util/dev update_lints` - [ ] Executed `util/dev update_lints`
- [ ] Added lint documentation - [ ] Added lint documentation
- [ ] Run `cargo fmt` - [ ] Run `./util/dev fmt`
### Cheatsheet ### Cheatsheet