Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add mising documentation regarding cargo doc #9565

Merged
merged 2 commits into from
Jun 10, 2021
Merged

Add mising documentation regarding cargo doc #9565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6128233
Add mising information regarding `cargo doc`
KubaP Jun 9, 2021
c37a6e3
Add missing information to the man pages
KubaP Jun 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/doc/man/cargo-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
3 changes: 2 additions & 1 deletion src/doc/man/generated_txt/cargo-doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/etc/man/cargo-doc.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down