Skip to content

Commit 71c4a0d

Browse files
committed
internal: cleanup CLI flag documentation
1 parent 2888069 commit 71c4a0d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

crates/rust-analyzer/src/cli/flags.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ xflags::xflags! {
5353

5454
/// Batch typecheck project and print summary statistics
5555
cmd analysis-stats {
56-
/// Directory with Cargo.toml.
56+
/// Directory with Cargo.toml or rust-project.json.
5757
required path: PathBuf
5858

5959
optional --output format: OutputFormat
@@ -74,7 +74,7 @@ xflags::xflags! {
7474

7575
/// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis.
7676
optional --disable-build-scripts
77-
/// Don't use expand proc macros.
77+
/// Don't expand proc macros.
7878
optional --disable-proc-macros
7979
/// Run the proc-macro-srv binary at the specified path.
8080
optional --proc-macro-srv path: PathBuf
@@ -101,7 +101,7 @@ xflags::xflags! {
101101

102102
/// Run unit tests of the project using mir interpreter
103103
cmd run-tests {
104-
/// Directory with Cargo.toml.
104+
/// Directory with Cargo.toml or rust-project.json.
105105
required path: PathBuf
106106
}
107107

@@ -115,38 +115,38 @@ xflags::xflags! {
115115
}
116116

117117
cmd diagnostics {
118-
/// Directory with Cargo.toml.
118+
/// Directory with Cargo.toml or rust-project.json.
119119
required path: PathBuf
120120

121121
/// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis.
122122
optional --disable-build-scripts
123-
/// Don't use expand proc macros.
123+
/// Don't expand proc macros.
124124
optional --disable-proc-macros
125125
/// Run the proc-macro-srv binary at the specified path.
126126
optional --proc-macro-srv path: PathBuf
127127
}
128128

129129
/// Report unresolved references
130130
cmd unresolved-references {
131-
/// Directory with Cargo.toml.
131+
/// Directory with Cargo.toml or rust-project.json.
132132
required path: PathBuf
133133

134134
/// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis.
135135
optional --disable-build-scripts
136-
/// Don't use expand proc macros.
136+
/// Don't expand proc macros.
137137
optional --disable-proc-macros
138138
/// Run the proc-macro-srv binary at the specified path.
139139
optional --proc-macro-srv path: PathBuf
140140
}
141141

142-
/// prime caches, as rust-analyzer does typically at startup in interactive sessions.
142+
/// Prime caches, as rust-analyzer does typically at startup in interactive sessions.
143143
cmd prime-caches {
144-
/// Directory with Cargo.toml.
144+
/// Directory with Cargo.toml or rust-project.json.
145145
required path: PathBuf
146146

147147
/// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis.
148148
optional --disable-build-scripts
149-
/// Don't use expand proc macros.
149+
/// Don't expand proc macros.
150150
optional --disable-proc-macros
151151
/// Run the proc-macro-srv binary at the specified path.
152152
optional --proc-macro-srv path: PathBuf

0 commit comments

Comments
 (0)