@@ -44,31 +44,43 @@ guidelines remains consistent and intelligible.
44
44
A guideline is an ** indicative statement** about a hypothetical crate.
45
45
46
46
``` diff
47
- - Not an imperative like "Implement Hex, Octal, Binary for binary number types"
48
- + Instead: "Binary number types provide Hex, Octal, Binary formatting"
49
-
50
- - Not an obligation like "Macros should compose well with attributes"
51
- + Instead: "Macros compose well with attributes"
47
+ Not an imperative like
48
+ - "Implement Hex, Octal, Binary for binary number types"
49
+ Instead:
50
+ + "Binary number types provide Hex, Octal, Binary formatting"
51
+
52
+ Not an obligation like
53
+ - "Macros should compose well with attributes"
54
+ Instead:
55
+ + "Macros compose well with attributes"
52
56
```
53
57
54
58
Guidelines have an explicit ** subject** and ** verb** .
55
59
56
60
``` diff
57
- - Not implicit subject like "Includes all common Cargo.toml metadata"
58
- + Instead: "Cargo.toml includes all common metadata"
59
-
60
- - Not implicit verb like "Thoroughly documented with examples"
61
- + Instead: "Crate level docs are thorough and include examples"
62
-
63
- - Not metaphysical like "There are no out-parameters"
64
- + Instead: "Functions do not take out-parameters"
61
+ Not implicit subject like
62
+ - "Includes all common Cargo.toml metadata"
63
+ Instead:
64
+ + "Cargo.toml includes all common metadata"
65
+
66
+ Not implicit verb like
67
+ - "Thoroughly documented with examples"
68
+ Instead:
69
+ + "Crate level docs are thorough and include examples"
70
+
71
+ Not metaphysical like
72
+ - "There are no out-parameters"
73
+ Instead:
74
+ + "Functions do not take out-parameters"
65
75
```
66
76
67
77
Guidelines use ** active voice** .
68
78
69
79
``` diff
70
- - Not passive voice like "Function arguments are validated"
71
- + Instead: "Functions validate their arguments"
80
+ Not passive voice like
81
+ - "Function arguments are validated"
82
+ Instead:
83
+ + "Functions validate their arguments"
72
84
```
73
85
74
86
## Conduct
0 commit comments