diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/style.md | 12 | ||||
-rw-r--r-- | docs/user/manual.adoc | 2 |
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md index 13c6a2a16..58b309379 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -63,6 +63,18 @@ After you are happy with the state of the code, please use [interactive rebase]( | |||
63 | Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors). | 63 | Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors). |
64 | Such messages create a lot of duplicate notification traffic during rebases. | 64 | Such messages create a lot of duplicate notification traffic during rebases. |
65 | 65 | ||
66 | If possible, write commit messages from user's perspective: | ||
67 | |||
68 | ``` | ||
69 | # Good | ||
70 | Goto definition works inside macros | ||
71 | |||
72 | # Not as good | ||
73 | Use original span for FileId | ||
74 | ``` | ||
75 | |||
76 | This makes it easier to prepare a changelog. | ||
77 | |||
66 | ## Clippy | 78 | ## Clippy |
67 | 79 | ||
68 | We don't enforce Clippy. | 80 | We don't enforce Clippy. |
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index d4121b401..75445a02e 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -339,7 +339,7 @@ interface Crate { | |||
339 | /// Path to the root module of the crate. | 339 | /// Path to the root module of the crate. |
340 | root_module: string; | 340 | root_module: string; |
341 | /// Edition of the crate. | 341 | /// Edition of the crate. |
342 | edition: "2015" | "2018"; | 342 | edition: "2015" | "2018" | "2021"; |
343 | /// Dependencies | 343 | /// Dependencies |
344 | deps: Dep[]; | 344 | deps: Dep[]; |
345 | /// Should this crate be treated as a member of current "workspace". | 345 | /// Should this crate be treated as a member of current "workspace". |