Clean up mess for --show-coverage documentation #90438

GuillaumeGomez · 2021-10-31T12:54:52Z

It was somewhat duplicated for some reasons... Anyway, this remove this duplication and clean up a bit.

camelid

IMO the docs for --show-coverage earlier on the page are clearer and more comprehensive than the docs near the end of the page. Can you keep the earlier docs and get rid of the later docs instead?

GuillaumeGomez · 2021-11-08T14:21:47Z

Updated!

camelid

r=me with these comments fixed

camelid · 2021-11-17T16:27:33Z

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

-$ rustdoc src/lib.rs -Z unstable-options --show-coverage
-+-------------------------------------+------------+------------+------------+------------+
-| File                                | Documented | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+
-| lib.rs                              |          4 |     100.0% |          1 |      25.0% |
-+-------------------------------------+------------+------------+------------+------------+
-| Total                               |          4 |     100.0% |          1 |      25.0% |
-+-------------------------------------+------------+------------+------------+------------+


Could you keep this example and put it in the merged section?

camelid · 2021-11-17T16:27:59Z

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

-Calculating code examples follows these rules:
-
-1. These items aren't accounted by default:
-  * struct/union field
-  * enum variant
-  * constant
-  * static
-  * typedef
-2. If one of the previously listed items has a code example, then it'll be counted.


It doesn't look like there's corresponding docs in the new section about this? Maybe move this part to the new section as well?

camelid · 2021-11-17T16:29:14Z

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

-[`--show-coverage`](https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#--show-coverage-get-statistics-about-code-documentation-coverage),
-passing `--output-format json` will display the coverage information in JSON format. For example,
-here is the JSON for a file with one documented item and one undocumented item:
+When using `--output-format json` with this option, it will display the coverage information in


Suggested change

When using `--output-format json` with this option, it will display the coverage information in

#### JSON output

When using `--output-format json` with this option, it will display the coverage information in

camelid · 2021-11-17T16:29:21Z

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

 [JSON format](https://github.com/rust-lang/rfcs/pull/2963). `--output-format html` has no effect,
 and is also accepted on stable toolchains.

+It can also be used with `--show-coverage`. Take a look at its
+[documentation](https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#--show-coverage-get-statistics-about-code-documentation-coverage) for more


Suggested change

[documentation](https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#--show-coverage-get-statistics-about-code-documentation-coverage) for more

[documentation](#--show-coverage-get-statistics-about-code-documentation-coverage) for more

GuillaumeGomez · 2021-11-18T11:57:27Z

Updated!

@bors: r=camelid rollup

bors · 2021-11-18T11:57:28Z

📌 Commit 530eaa8 has been approved by camelid

…=camelid Clean up mess for --show-coverage documentation It was somewhat duplicated for some reasons... Anyway, this remove this duplication and clean up a bit. r? `@camelid`

…=camelid Clean up mess for --show-coverage documentation It was somewhat duplicated for some reasons... Anyway, this remove this duplication and clean up a bit. r? ``@camelid``

Rollup of 8 pull requests Successful merges: - rust-lang#90386 (Add `-Zassert-incr-state` to assert state of incremental cache) - rust-lang#90438 (Clean up mess for --show-coverage documentation) - rust-lang#90480 (Mention `Vec::remove` in `Vec::swap_remove`'s docs) - rust-lang#90607 (Make slice->str conversion and related functions `const`) - rust-lang#90750 (rustdoc: Replace where-bounded Clean impl with simple function) - rust-lang#90895 (require full validity when determining the discriminant of a value) - rust-lang#90989 (Avoid suggesting literal formatting that turns into member access) - rust-lang#91002 (rustc: Remove `#[rustc_synthetic]`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

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

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? `@camelid`

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? ``@camelid``

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? ```@camelid```

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? ````@camelid````

GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Oct 31, 2021

rust-highfive assigned camelid Oct 31, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 31, 2021

camelid requested changes Nov 1, 2021

View reviewed changes

camelid added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 1, 2021

GuillaumeGomez force-pushed the doc-show-coverage branch from 14ef028 to da895f9 Compare November 8, 2021 14:21

GuillaumeGomez added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 8, 2021

camelid approved these changes Nov 17, 2021

View reviewed changes

camelid added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 17, 2021

Clean up mess for --show-coverage documentation

530eaa8

GuillaumeGomez force-pushed the doc-show-coverage branch from da895f9 to 530eaa8 Compare November 18, 2021 10:59

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 18, 2021

JohnTitor mentioned this pull request Nov 18, 2021

Rollup of 6 pull requests #91013

Closed

JohnTitor mentioned this pull request Nov 18, 2021

Rollup of 9 pull requests #91016

Closed

JohnTitor mentioned this pull request Nov 18, 2021

Rollup of 8 pull requests #91019

Merged

bors merged commit 153e4dc into rust-lang:master Nov 18, 2021

rustbot added this to the 1.58.0 milestone Nov 18, 2021

camelid reviewed Nov 19, 2021

View reviewed changes

src/doc/rustdoc/src/unstable-features.md Show resolved Hide resolved

GuillaumeGomez deleted the doc-show-coverage branch November 19, 2021 08:57

camelid mentioned this pull request Nov 19, 2021

Put back removed empty line #91035

Merged

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 19, 2021

Rollup merge of rust-lang#91035 - GuillaumeGomez:put-back-removed-emp…

f382877

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? `@camelid`

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 19, 2021

Rollup merge of rust-lang#91035 - GuillaumeGomez:put-back-removed-emp…

b0e029d

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? ``@camelid``

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 19, 2021

Rollup merge of rust-lang#91035 - GuillaumeGomez:put-back-removed-emp…

f0e2042

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? ```@camelid```

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 20, 2021

Rollup merge of rust-lang#91035 - GuillaumeGomez:put-back-removed-emp…

98540c6

…ty-line, r=camelid Put back removed empty line Fixes comment from rust-lang#90438 (comment). r? ````@camelid````

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up mess for --show-coverage documentation #90438

Clean up mess for --show-coverage documentation #90438

GuillaumeGomez commented Oct 31, 2021

camelid left a comment

GuillaumeGomez commented Nov 8, 2021

camelid left a comment

camelid Nov 17, 2021

camelid Nov 17, 2021

camelid Nov 17, 2021

camelid Nov 17, 2021

GuillaumeGomez commented Nov 18, 2021

bors commented Nov 18, 2021

	[documentation](https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#--show-coverage-get-statistics-about-code-documentation-coverage) for more
	[documentation](#--show-coverage-get-statistics-about-code-documentation-coverage) for more

Clean up mess for --show-coverage documentation #90438

Clean up mess for --show-coverage documentation #90438

Conversation

GuillaumeGomez commented Oct 31, 2021

camelid left a comment

Choose a reason for hiding this comment

GuillaumeGomez commented Nov 8, 2021

camelid left a comment

Choose a reason for hiding this comment

camelid Nov 17, 2021

Choose a reason for hiding this comment

camelid Nov 17, 2021

Choose a reason for hiding this comment

camelid Nov 17, 2021

Choose a reason for hiding this comment

camelid Nov 17, 2021

Choose a reason for hiding this comment

GuillaumeGomez commented Nov 18, 2021

bors commented Nov 18, 2021