Skip to content

Commit 2f535a4

Browse files
Rename theme-checker option to check-theme
1 parent 5b2862c commit 2f535a4

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

src/doc/rustdoc/src/command-line-arguments.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ you'll need to this flag as follows:
368368
$ rustdoc src/lib.rs --themes /path/to/your/theme/file.css
369369
```
370370

371-
### `theme-checker`: check if your themes implement all the required rules
371+
### `check-theme`: check if your themes implement all the required rules
372372

373373
This flag allows you to check if your themes implement the necessary CSS rules. To put it more
374374
simply, when adding a new theme, it needs to implements all the CSS rules present in the "light"
@@ -377,5 +377,5 @@ CSS theme.
377377
You can use this flag like this:
378378

379379
```bash
380-
$ rustdoc src/lib.rs --theme-checker /path/to/your/theme/file.css
380+
$ rustdoc src/lib.rs --check-theme /path/to/your/theme/file.css
381381
```

src/doc/rustdoc/src/unstable-features.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -334,14 +334,14 @@ $ rustdoc src/lib.rs -Z unstable-options --themes theme.css
334334

335335
Giving this flag to `rustdoc` will make it copy your theme into the generated crate docs and enable
336336
it in the theme selector. Note that `rustdoc` will reject your theme file if it doesn't style
337-
everything the "light" theme does. See `--theme-checker` below for details.
337+
everything the "light" theme does. See `--check-theme` below for details.
338338

339-
### `--theme-checker`: verify theme CSS for validity
339+
### `--check-theme`: verify theme CSS for validity
340340

341341
Using this flag looks like this:
342342

343343
```bash
344-
$ rustdoc -Z unstable-options --theme-checker theme.css
344+
$ rustdoc -Z unstable-options --check-theme theme.css
345345
```
346346

347347
Before including your theme in crate docs, `rustdoc` will compare all the CSS rules it contains

src/librustdoc/html/static_files.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ pub static RUST_FAVICON: &'static [u8] = include_bytes!("static/favicon.ico");
5959
/// The built-in themes given to every documentation site.
6060
pub mod themes {
6161
/// The "light" theme, selected by default when no setting is available. Used as the basis for
62-
/// the `--theme-checker` functionality.
62+
/// the `--check-theme` functionality.
6363
pub static LIGHT: &'static str = include_str!("static/themes/light.css");
6464

6565
/// The "dark" theme.

src/librustdoc/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,8 @@ fn opts() -> Vec<RustcOptGroup> {
252252
"additional themes which will be added to the generated docs",
253253
"FILES")
254254
}),
255-
stable("theme-checker", |o| {
256-
o.optmulti("", "theme-checker",
255+
stable("check-theme", |o| {
256+
o.optmulti("", "check-theme",
257257
"check if given theme is valid",
258258
"FILES")
259259
}),

src/tools/rustdoc-themes/main.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ fn main() {
3939
exit(1);
4040
}
4141
let status = Command::new(rustdoc_bin)
42-
.args(&["-Z", "unstable-options", "--theme-checker"])
42+
.args(&["-Z", "unstable-options", "--check-theme"])
4343
.args(&themes)
4444
.status()
4545
.expect("failed to execute child");

0 commit comments

Comments
 (0)