Skip to content

Commit 678befe

Browse files
polazarushg-anssi
authored andcommitted
add note about clippy
1 parent 26d06fa commit 678befe

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

src/en/naming.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,20 @@ particular constructs:
3232
- (C-FEATURE) for feature naming (conditionally enabled functionalities),
3333
- (C-WORD-ORDER) for word order consistency.
3434

35+
<div class="note">
36+
37+
The basic rule (C-CASE) is checked by the compiler (with the `nonstandard_style` lint set).
38+
39+
In addition to the compiler, the [`clippy`](./devenv.md#clippy) tool can help in adopting naming conventions with the `style` lint category.
40+
For example, the `wrong_self_convention` lint checks the consistency between conversion method names and their receiver types (`self`, `&self`, `&mut self`) according to (C-CONV).
41+
42+
<!--
43+
clippy::enum_variant_names
44+
clippy::self_named_constructors
45+
-->
46+
47+
</div>
48+
3549
<div class="reco" id="LANG-NAMING" type="Rule" title="Respect naming conventions">
3650

3751
Development of a secure application MUST follow the naming conventions

src/fr/naming.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,23 @@ plus précises pour certaines constructions particulières :
3636
- (C-FEATURE) pour les noms de *features* (fonctionnalités activables par configuration) ;
3737
- (C-WORD-ORDER) pour la cohérence sur l'ordre des mots.
3838

39+
<div class="note">
40+
41+
Les règles de base sont vérifiées par le compilateur (jeu d'avertissements `nonstandard_style`).
42+
43+
En complément du compilateur, l'outil [`clippy`](devenv.md#clippy) permet de faciliter l'adoption des conventions de nommage usuelles à travers la catégorie `style`.
44+
Par exemple, la vérification `wrong_self_convention` contrôle la cohérence entre les noms des méthodes de conversion et le type du receveur (`self`, `&self`, `&mut self`), suivant (C-CONV).
45+
46+
<!--
47+
clippy::enum_variant_names
48+
clippy::self_named_constructors
49+
-->
50+
51+
</div>
52+
3953
<div class="reco" id="LANG-NAMING" type="Règle" title="Respect des conventions de nommage">
4054

4155
Le développement d'une application sécurisée DOIT suivre les conventions de
4256
nommage décrites dans les [@rust-guidelines].
4357

4458
</div>
45-

0 commit comments

Comments
 (0)