Skip to content

Don't promise that we talk about Rustdoc more #20247

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

Merged
merged 1 commit into from
Dec 31, 2014
+2 −3
Merged

Don't promise that we talk about Rustdoc more #20247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions src/doc/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,9 +884,8 @@ fn hello(name: &str) {
When writing doc comments, adding sections for any arguments, return values,
and providing some examples of usage is very, very helpful.

You can use the `rustdoc` tool to generate HTML documentation from these doc
comments. We will talk more about `rustdoc` when we get to modules, as
generally, you want to export documentation for a full module.
You can use the [`rustdoc`](rustdoc.html) tool to generate HTML documentation
from these doc comments.

# Compound Data Types

Expand Down