Updated documentation to use range notation syntax #21834

genbattle · 2015-02-01T05:44:38Z

Replaced outdated use of the range(start, end) function where appropriate with start..end, and tweaked the examples to compile and run with the latest rust. I also fixed two periphery compile issues in reference.md which were occluding whether there were any new errors created by these changes.

rust-highfive · 2015-02-01T05:44:45Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see CONTRIBUTING.md for more information.

edwardw · 2015-02-01T07:53:54Z

src/doc/reference.md

@@ -2994,7 +2994,7 @@ Some examples of call expressions:
 # fn add(x: i32, y: i32) -> i32 { 0 }

 let x: i32 = add(1i32, 2i32);
-let pi: Option<f32> = "3.14".parse().ok();
+let pi: Option<f32> = "3.14".parse();


let pi: Result<f32, _> = "3.14".parse(); The API has been changed.

When was it updated? The documentation still seems to refer to it returning an Option.

It is #21718, just yesterday fresh out of the oven.

I have no compiler to test against, the latest rust-nightly-bin package is (1d00c54 2015-01-30 19:56:34 +0000). I can't fix this issue and verify that it works until the nightly is updated to include your change; currently I just get:

[nick@hacksaw range-test]$ rustc main.rs main.rs:12:30: 12:44 error: mismatched types: expected `core::result::Result<f32, _>`, found `core::option::Option<_>` (expected enum `core::result::Result`, found enum `core::option::Option`) [E0308] main.rs:12 let pi: Result<f32, _> = "3.14".parse(); ^~~~~~~~~~~~~~

I have no time to work on this tonight or tomorrow night, but I may be able to compile the latest rustc on Wednesday night local (GMT+12).

You have Option< in that error message, not Result<.

Why not open a separate PR to update all the doc examples affected by #21718 instead of cramming it into this one? src/doc/trpl/guessing-game.md has at least 9 occurrences of this error.

That's, of course, a viable solution too. Fine with me.

steveklabnik · 2015-02-06T04:26:32Z

This needs a rebase now, but I'm interested in moving it forward.

genbattle · 2015-02-06T05:06:35Z

I know how to rebase my branch against master in my fork, but I haven't used github enough to figure out the best way to update my fork with mainline rust - github seems to suggest pulling the changes from mainline rust via a pull request into my fork. Is this the best way to go about it, or is there a cleaner/easier way to do this?

genbattle · 2015-02-06T05:12:42Z

No matter, figured it out, rebasing now.

steveklabnik · 2015-02-06T05:20:53Z

I have this setup:

$ git remote -v
origin  git@github.com:steveklabnik/rust.git (fetch)
origin  git@github.com:steveklabnik/rust.git (push)
upstream        https://github.com/rust-lang/rust.git (fetch)
upstream        https://github.com/rust-lang/rust.git (push)

and then

$ git checkout mybranch
$ git fetch upstream
$ git rebase upstream/master # with all that this entails...
$ git push origin -f mybranch

genbattle · 2015-02-06T05:42:52Z

After I did the rebase git insisted I pull and merge with my remote, but obviously in this case a push -f would have been the better option. It seems to have worked, although I don't know what it's done to the history :-/

fujin · 2015-02-06T05:44:58Z

Use the reflog to hard move your branch pointer back before you pull/merged, rebase again, check fast-forward, then git push --force-with-lease. 0

genbattle · 2015-02-06T05:47:49Z

I reset to before the pull/merge and force pushed, it seems to have corrected it?

fujin · 2015-02-06T05:48:52Z

@genbattle Indeed; Thank you.

genbattle · 2015-02-06T12:08:21Z

Steve, don't push this through yet. I just realized I don't think I ended
up fixing up newly created occurrences of range(start, end) when I did the
merge for the rebase, I'll get onto this in the morning and add another
commit to this PR.
On 6 Feb 2015 6:49 pm, "AJ Christensen" notifications@github.com wrote:

@genbattle https://github.com/genbattle Indeed; Thank you.

—
Reply to this email directly or view it on GitHub
#21834 (comment).

genbattle · 2015-02-06T22:47:40Z

There was only one additional instance of the range function instead of range notation, so I've fixed it up, tested it, and added it to this branch.

steveklabnik · 2015-02-10T03:34:46Z

This looks great, @genbattle , except the original comment about Result. Do these tests pass? Other than that, this looks great, r=me

Replaced outdated use of the `range(start, end)` function where approriate with `start..end`, and tweaked the examples to compile and run with the latest rust. I also fixed two periphery compile issues in reference.md which were occluding whether there were any new errors created by these changes, so I fixed them.

genbattle · 2015-02-12T07:58:15Z

@steveklabnik I've fixed the usage of StrExt.parse() that @edwardw originally commented on. I also fixed all similar occurrences in doc/trpl/guessing-game.md.

I did another rebase and tested against all of the examples in all of the files touched by this PR and fixed any errors that arose. It should be all good to go unless you have any more comments or recommendations for me?

steveklabnik · 2015-02-13T13:01:00Z

@bors: r+ 8300095

steveklabnik · 2015-02-13T13:01:13Z

Nope, looks great! Thnak you! (not rolling up since this is a big ish change)

bors · 2015-02-13T13:15:33Z

⌛ Testing commit 8300095 with merge 4760750...

bors · 2015-02-13T15:05:17Z

💔 Test failed - auto-win-64-opt

steveklabnik · 2015-02-13T15:07:05Z

@bors: retry

bors · 2015-02-13T16:25:12Z

⌛ Testing commit 8300095 with merge 5b543c1...

bors · 2015-02-13T17:53:35Z

💔 Test failed - auto-mac-64-opt

alexcrichton · 2015-02-14T01:49:33Z

@bors: retry

bors · 2015-02-14T03:10:40Z

⌛ Testing commit 8300095 with merge f174bca...

Replaced outdated use of the `range(start, end)` function where appropriate with `start..end`, and tweaked the examples to compile and run with the latest rust. I also fixed two periphery compile issues in reference.md which were occluding whether there were any new errors created by these changes.

bors · 2015-02-14T05:35:44Z

☀️ Test successful - auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-32-nopt-t, auto-win-32-opt, auto-win-64-nopt-t, auto-win-64-opt

rust-highfive assigned steveklabnik Feb 1, 2015

edwardw reviewed Feb 1, 2015
View reviewed changes

genbattle added 3 commits February 12, 2015 18:51

Fixed one newly created instance of range(start, end).

9e9b1d6

Updated usage of StrExt.parse() as per a recommendation by edwardw.

8300095

bors merged commit 8300095 into rust-lang:master Feb 14, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated documentation to use range notation syntax #21834

Updated documentation to use range notation syntax #21834

genbattle commented Feb 1, 2015

rust-highfive commented Feb 1, 2015

edwardw Feb 1, 2015

genbattle Feb 1, 2015

edwardw Feb 1, 2015

genbattle Feb 2, 2015

steveklabnik Feb 2, 2015

genbattle Feb 2, 2015

edwardw Feb 2, 2015

steveklabnik commented Feb 6, 2015

genbattle commented Feb 6, 2015

genbattle commented Feb 6, 2015

steveklabnik commented Feb 6, 2015

genbattle commented Feb 6, 2015

fujin commented Feb 6, 2015

genbattle commented Feb 6, 2015

fujin commented Feb 6, 2015

genbattle commented Feb 6, 2015

genbattle commented Feb 6, 2015

steveklabnik commented Feb 10, 2015

genbattle commented Feb 12, 2015

steveklabnik commented Feb 13, 2015

steveklabnik commented Feb 13, 2015

bors commented Feb 13, 2015

bors commented Feb 13, 2015

steveklabnik commented Feb 13, 2015

bors commented Feb 13, 2015

bors commented Feb 13, 2015

alexcrichton commented Feb 14, 2015

bors commented Feb 14, 2015

bors commented Feb 14, 2015

Updated documentation to use range notation syntax #21834

Updated documentation to use range notation syntax #21834

Conversation

genbattle commented Feb 1, 2015

rust-highfive commented Feb 1, 2015

edwardw Feb 1, 2015

Choose a reason for hiding this comment

genbattle Feb 1, 2015

Choose a reason for hiding this comment

edwardw Feb 1, 2015

Choose a reason for hiding this comment

genbattle Feb 2, 2015

Choose a reason for hiding this comment

steveklabnik Feb 2, 2015

Choose a reason for hiding this comment

genbattle Feb 2, 2015

Choose a reason for hiding this comment

edwardw Feb 2, 2015

Choose a reason for hiding this comment

steveklabnik commented Feb 6, 2015

genbattle commented Feb 6, 2015

genbattle commented Feb 6, 2015

steveklabnik commented Feb 6, 2015

genbattle commented Feb 6, 2015

fujin commented Feb 6, 2015

genbattle commented Feb 6, 2015

fujin commented Feb 6, 2015

genbattle commented Feb 6, 2015

genbattle commented Feb 6, 2015

steveklabnik commented Feb 10, 2015

genbattle commented Feb 12, 2015

steveklabnik commented Feb 13, 2015

steveklabnik commented Feb 13, 2015

bors commented Feb 13, 2015

bors commented Feb 13, 2015

steveklabnik commented Feb 13, 2015

bors commented Feb 13, 2015

bors commented Feb 13, 2015

alexcrichton commented Feb 14, 2015

bors commented Feb 14, 2015

bors commented Feb 14, 2015