Skip to content

Commit

Permalink
auto merge of #17402 : steveklabnik/rust/update_manual, r=brson
Browse files Browse the repository at this point in the history
Because I'm still 😷 😷 😷 , I figured some mindless tasks would be better than trying to finish the ownership guide. 

The manual has long been waiting for some ❤️ ❤️ ❤️ , and so I gave it a quick once-over. I made small commits in case any of the changes are a bit weird, I mostly did a few things:

1. changed 'manual' to 'reference.' I feel like this name is better. If it's not, It's not a huge deal. it shouldn't be `rust.md` though.
2. word wrapped everything appropriately. Changes 1&2 are in the first commit, so that its' easier to see the changes in the later ones.
3. fixed other small style issues
4. removed references to things that are in the standard library, and not the language itself

There's still lots of gross in here, but I didn't want to pile on too too many changes.

/cc @brson @nikomatsakis
  • Loading branch information
bors committed Sep 23, 2014
2 parents 7fbbfe6 + c765178 commit c669411
Show file tree
Hide file tree
Showing 7 changed files with 4,298 additions and 4,422 deletions.
4 changes: 2 additions & 2 deletions mk/docs.mk
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
guide-tasks guide-container guide-pointers guide-testing \
guide-runtime complement-bugreport \
complement-lang-faq complement-design-faq complement-project-faq rust \
rustdoc guide-unsafe guide-strings
rustdoc guide-unsafe guide-strings reference

PDF_DOCS := guide rust
PDF_DOCS := guide reference

RUSTDOC_DEPS_rust := doc/full-toc.inc
RUSTDOC_FLAGS_rust := --html-in-header=doc/full-toc.inc
Expand Down
2 changes: 1 addition & 1 deletion src/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To generate an HTML version of a doc from Markdown manually, you can do
something like:

~~~~
pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
~~~~

(rust.md being the Rust Reference Manual.)
Expand Down
2 changes: 1 addition & 1 deletion src/doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ development of Rust itself is discussed.
# Specification

Rust does not have an exact specification, but an effort to describe as much of
the language in as much detail as possible is in [the manual](rust.html).
the language in as much detail as possible is in [the reference](reference.html).

# Guides

Expand Down
2 changes: 1 addition & 1 deletion src/doc/not_found.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Some things that might be helpful to you though:

## Reference
* [The Rust official site](http://rust-lang.org)
* [The Rust reference manual](http://doc.rust-lang.org/rust.html) (* [PDF](http://doc.rust-lang.org/rust.pdf))
* [The Rust reference](http://doc.rust-lang.org/reference.html) (* [PDF](http://doc.rust-lang.org/reference.pdf))

## Docs
* [The standard library](http://doc.rust-lang.org/std/)
Loading

0 comments on commit c669411

Please sign in to comment.