Skip to content

[review] DENV-FORMAT #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[review] DENV-FORMAT #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 2 additions & 15 deletions src/en/devenv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,19 +217,7 @@ a secure application.

### Rustfmt

[Rustfmt] is a tool that formats your code according to style guidelines. The
documentation of the tool states some limitations, among others partial support
of macro declarations and uses. One should use the `--check` option that prints
proposed changes, review these changes, and finally apply them if the code
readability is not affected.

So, to launch it:

```shell
$ cargo fmt -- --check
$ # review of the changes
$ cargo fmt
```
[Rustfmt] is a tool that formats your code according to style guidelines.

These guidelines can be customized to your needs by creating a `rustfmt.toml` or
`.rustfmt.toml` file at the root of your project. It will be used to override
Expand All @@ -248,8 +236,7 @@ at the [Rust Style Guide](https://doc.rust-lang.org/style-guide/index.html).
<div class="reco" id="DENV-FORMAT" type="Rule" title="Use Rust formatter (rustfmt)">

The tool `rustfmt` can be used to ensure that the codebase respects style
guidelines (as described in `rustfmt.toml` file), with `--check` option and
manual review.
guidelines (as described in `rustfmt.toml` file).

</div>

Expand Down
19 changes: 2 additions & 17 deletions src/fr/devenv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,21 +239,7 @@ développement d'une application sécurisée.
### Rustfmt

[Rustfmt] est un outil offrant la possibilité de formater du code en fonction
de consignes de style (*style guidelines*). La documentation de l'outil
mentionne certaines limitations parmi lesquelles un support partiel des macros
(déclaration et utilisation). L'option `--check`, qui affiche les différences
de formatage entre le code actuel et le code proposé, doit être utilisé. À la
suite de cette première utilisation, l'utilisateur doit vérifier les
changements, puis éventuellement les valider en réinvoquant l'outil sans
option.

En résumé :

```shell
$ cargo fmt -- --check
$ # review of the changes
$ cargo fmt
```
de consignes de style (*style guidelines*).

Les règles de convention de style peuvent être personnalisées au besoin dans
le fichier `rustfmt.toml` ou `.rustfmt.toml` à la racine du projet. Il sera
Expand All @@ -273,8 +259,7 @@ Pour plus d'informations à propos des règles de convention de style que

L'outil de formatage `rustfmt` peut être utilisé pour assurer le respect de
règles de convention de style (comme décrites dans le fichier `rustfmt.toml`)
sur une base de code, avec l'option `--check` ainsi qu'une revue de code
manuelle.
> sur une base de code.

</div>

Expand Down