Skip to content

Update rustdoc man page #42180

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.

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

Merged
merged 1 commit into from
May 30, 2017
Merged

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented May 23, 2017

r? @rust-lang/docs
r? @rust-lang/dev-tools

@QuietMisdreavus
Copy link
Member

It still includes the section about output formats, including JSON output. >_>

man/rustdoc.1 Outdated
don't include table of contents
.TP
\fB\-h\fR, \fB\-\-extend\-css\fR
to redefine some css rules with a given file to generate doc with your own theme
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be in sync with #41700

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't expect it to be merged before it so perfect. :D

@arielb1 arielb1 added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 23, 2017
@GuillaumeGomez
Copy link
Member Author

Updated.

man/rustdoc.1 Outdated
.TP
\fB\-V\fR, \fB\-\-version\fR
Print rustdoc's version

.SH "OUTPUT FORMATS"

The rustdoc tool can generate output in either an HTML or JSON format.
The rustdoc tool can generate output in either an HTML or Markdown format.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rustdoc can't create Markdown files, can't it? I was under the impression that the only thing rustdoc can output is the regular HTML pages.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum indeed, confused with the markdown input.

@Mark-Simulacrum Mark-Simulacrum 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 May 28, 2017
@GuillaumeGomez
Copy link
Member Author

Updated.

Copy link
Member

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! r=me after this.

man/rustdoc.1 Outdated
Print help
\fB\-\-markdown\-no\-toc\fR
don't include table of contents
.TP
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicated lines

@GuillaumeGomez
Copy link
Member Author

@bors: r=QuietMisdreavus rollup

@bors
Copy link
Collaborator

bors commented May 29, 2017

📌 Commit 4785441 has been approved by QuietMisdreavus

@bors
Copy link
Collaborator

bors commented May 30, 2017

⌛ Testing commit 4785441 with merge 0c4fb24...

bors added a commit that referenced this pull request May 30, 2017
…reavus

Update rustdoc man page

r? @rust-lang/docs
r? @rust-lang/dev-tools
@bors
Copy link
Collaborator

bors commented May 30, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: QuietMisdreavus
Pushing 0c4fb24 to master...

@bors bors merged commit 4785441 into rust-lang:master May 30, 2017
@GuillaumeGomez GuillaumeGomez deleted the update-rustdoc-man branch May 30, 2017 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants