itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #9565 - KubaP:doc-fix, r=ehuss

Browse Source 
Add mising documentation regarding `cargo doc`

It seems that the `--document-private-items` flag for `cargo doc` is automatically set when documenting a binary target. This change mentions that in the doc page.

The documentation did not mention this before, and it got me confused whilst I was trying to track down something going wrong.
This commit is contained in:
bors 2021-06-10 16:12:42 +00:00
commit c3a16b3431
4 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/doc/man/cargo-doc.md
View File

@ -32,7 +32,7 @@ Do not build documentation for dependencies.
{{/option}}
{{#option "`--document-private-items`" }}
Include non-public items in the documentation.
Include non-public items in the documentation. This will be enabled by default if documenting a binary target.
{{/option}}
{{/options}}

3
src/doc/man/generated_txt/cargo-doc.txt
View File

@ -23,7 +23,8 @@ OPTIONS
Do not build documentation for dependencies.
--document-private-items
Include non-public items in the documentation.
Include non-public items in the documentation. This will be enabled
by default if documenting a binary target.
Package Selection
By default, when no package selection options are given, the packages

2
src/doc/src/commands/cargo-doc.md
View File

@ -32,7 +32,7 @@ option.</dd>
<dt class="option-term" id="option-cargo-doc---document-private-items"><a class="option-anchor" href="#option-cargo-doc---document-private-items"></a><code>--document-private-items</code></dt>
<dd class="option-desc">Include non-public items in the documentation.</dd>
<dd class="option-desc">Include non-public items in the documentation. This will be enabled by default if documenting a binary target.</dd>
</dl>

2
src/etc/man/cargo-doc.1
View File

@ -28,7 +28,7 @@ Do not build documentation for dependencies.
.sp
\fB\-\-document\-private\-items\fR
.RS 4
Include non\-public items in the documentation.
Include non\-public items in the documentation. This will be enabled by default if documenting a binary target.
.RE
.SS "Package Selection"
By default, when no package selection options are given, the packages selected