<feed xmlns='http://www.w3.org/2005/Atom'>
<title>rust/src/doc/rustdoc.md, branch 1.44.0</title>
<subtitle>https://github.com/rust-lang/rust
</subtitle>
<id>http://git.dreamy.place/mirrors/rust/atom?h=1.44.0</id>
<link rel='self' href='http://git.dreamy.place/mirrors/rust/atom?h=1.44.0'/>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/'/>
<updated>2015-01-21T19:59:25+00:00</updated>
<entry>
<title>Move rustdoc.md into the book</title>
<updated>2015-01-21T19:59:25+00:00</updated>
<author>
<name>Steve Klabnik</name>
<email>steve@steveklabnik.com</email>
</author>
<published>2015-01-21T19:59:25+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=23da54d894f3354bf6e6d560940be6741648d68f'/>
<id>urn:sha1:23da54d894f3354bf6e6d560940be6741648d68f</id>
<content type='text'>
Fixes #21430
</content>
</entry>
<entry>
<title>rollup merge of #21041: steveklabnik/gh17554</title>
<updated>2015-01-15T22:11:37+00:00</updated>
<author>
<name>Alex Crichton</name>
<email>alex@alexcrichton.com</email>
</author>
<published>2015-01-15T22:11:37+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=2890266b27b7dafc848af77baaa6d3a71141aef4'/>
<id>urn:sha1:2890266b27b7dafc848af77baaa6d3a71141aef4</id>
<content type='text'>
Fixes #17554
</content>
</entry>
<entry>
<title>Add explanation of main to rustdoc docs</title>
<updated>2015-01-15T14:58:58+00:00</updated>
<author>
<name>Steve Klabnik</name>
<email>steve@steveklabnik.com</email>
</author>
<published>2015-01-12T20:42:27+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=462dd647163195bbe4736c933588af3907ac6a38'/>
<id>urn:sha1:462dd647163195bbe4736c933588af3907ac6a38</id>
<content type='text'>
Fixes #17554
</content>
</entry>
<entry>
<title>Replace usage of deriving with derive in docs</title>
<updated>2015-01-13T13:57:09+00:00</updated>
<author>
<name>Greg Chapple</name>
<email>gregchapple1@gmail.com</email>
</author>
<published>2015-01-06T10:56:14+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=4b14f67df3c28cd1cd8ea5bf794a3e542c663d8d'/>
<id>urn:sha1:4b14f67df3c28cd1cd8ea5bf794a3e542c663d8d</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Mostly rote conversion of `proc()` to `move||` (and occasionally `Thunk::new`)</title>
<updated>2014-12-14T09:21:56+00:00</updated>
<author>
<name>Niko Matsakis</name>
<email>niko@alum.mit.edu</email>
</author>
<published>2014-11-26T13:12:18+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=5c3d3989192f88b16f39d554c3844700c91b6c8e'/>
<id>urn:sha1:5c3d3989192f88b16f39d554c3844700c91b6c8e</id>
<content type='text'>
</content>
</entry>
<entry>
<title>auto merge of #18381 : pelmers/rust/patch-1, r=alexcrichton</title>
<updated>2014-10-31T00:22:19+00:00</updated>
<author>
<name>bors</name>
<email>bors@rust-lang.org</email>
</author>
<published>2014-10-31T00:22:19+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=a12d06b73fcb38cf23dfe71da725428a1094395f'/>
<id>urn:sha1:a12d06b73fcb38cf23dfe71da725428a1094395f</id>
<content type='text'>
Happened to be reading through the doc.
</content>
</entry>
<entry>
<title>Rename fail! to panic!</title>
<updated>2014-10-29T15:43:07+00:00</updated>
<author>
<name>Steve Klabnik</name>
<email>steve@steveklabnik.com</email>
</author>
<published>2014-10-09T19:17:22+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=7828c3dd2858d8f3a0448484d8093e22719dbda0'/>
<id>urn:sha1:7828c3dd2858d8f3a0448484d8093e22719dbda0</id>
<content type='text'>
https://github.com/rust-lang/rfcs/pull/221

The current terminology of "task failure" often causes problems when
writing or speaking about code. You often want to talk about the
possibility of an operation that returns a Result "failing", but cannot
because of the ambiguity with task failure. Instead, you have to speak
of "the failing case" or "when the operation does not succeed" or other
circumlocutions.

Likewise, we use a "Failure" header in rustdoc to describe when
operations may fail the task, but it would often be helpful to separate
out a section describing the "Err-producing" case.

We have been steadily moving away from task failure and toward Result as
an error-handling mechanism, so we should optimize our terminology
accordingly: Result-producing functions should be easy to describe.

To update your code, rename any call to `fail!` to `panic!` instead.
Assuming you have not created your own macro named `panic!`, this
will work on UNIX based systems:

    grep -lZR 'fail!' . | xargs -0 -l sed -i -e 's/fail!/panic!/g'

You can of course also do this by hand.

[breaking-change]
</content>
</entry>
<entry>
<title>Small grammar fix in rustdoc.md</title>
<updated>2014-10-28T01:58:05+00:00</updated>
<author>
<name>Peter Elmers</name>
<email>peter.elmers@yahoo.com</email>
</author>
<published>2014-10-28T01:58:05+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=7163d65e24b9ccdd596c0af8d07bcb52b972ea15'/>
<id>urn:sha1:7163d65e24b9ccdd596c0af8d07bcb52b972ea15</id>
<content type='text'>
Happened to be reading through</content>
</entry>
<entry>
<title>docs: Reference hoedown instead of sundown</title>
<updated>2014-10-04T17:42:23+00:00</updated>
<author>
<name>Brian Campbell</name>
<email>lambda@continuation.org</email>
</author>
<published>2014-10-04T17:42:23+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=fe8f43030a710eeee1043061145abf2b47c5e601'/>
<id>urn:sha1:fe8f43030a710eeee1043061145abf2b47c5e601</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Fix example in docs on documentation</title>
<updated>2014-07-02T08:53:30+00:00</updated>
<author>
<name>Derecho</name>
<email>derecho@sector5d.org</email>
</author>
<published>2014-07-02T08:53:30+00:00</published>
<link rel='alternate' type='text/html' href='http://git.dreamy.place/mirrors/rust/commit/?id=c85d42a3054e2859aac67b143485f6cd8a0693e9'/>
<id>urn:sha1:c85d42a3054e2859aac67b143485f6cd8a0693e9</id>
<content type='text'>
</content>
</entry>
</feed>
