refactor range examples #35759

matthew-piziak · 2016-08-17T18:55:22Z

This pull request adds a module-level example of how all the range operators work. It also slims down struct-level examples in lieu of a link to module examples.

rust-highfive · 2016-08-17T18:55:36Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (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. Due to 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 the contribution instructions for more information.

matthew-piziak · 2016-08-17T18:55:43Z

r? @steveklabnik

steveklabnik · 2016-08-17T18:58:59Z

src/libcore/ops.rs

+//! assert_eq!(arr[1..3], [  1,2    ]); // Range
+//!
+//! assert_eq!(arr[ ...3], [0,1,2,3 ]); // RangeToIncusive
+//! assert_eq!(arr[1...3], [  1,2,3 ]); // RangeInclusive


I know you copied these from the existing examples, but I wonder if we should eliminate the extra spacing, since it's not idiomatic Rust. Hmm

We could just add a note to that effect.

On Aug 17, 2016 2:59 PM, "Steve Klabnik" notifications@github.com wrote:

In src/libcore/ops.rs
#35759 (comment):

@@ -64,6 +64,20 @@
//!
//! See the documentation for each trait for a minimum implementation that
//! prints something to the screen.
+//!
+//! This example shows the behavior of the various Range* structs.
+//!
+//! ```rust
+//! let arr = [0, 1, 2, 3, 4];
+//!
+//! assert_eq!(arr[ .. ], [0,1,2,3,4]); // RangeFull
+//! assert_eq!(arr[ ..3], [0,1,2 ]); // RangeTo
+//! assert_eq!(arr[1.. ], [ 1,2,3,4]); // RangeFrom
+//! assert_eq!(arr[1..3], [ 1,2 ]); // Range
+//!
+//! assert_eq!(arr[ ...3], [0,1,2,3 ]); // RangeToIncusive
+//! assert_eq!(arr[1...3], [ 1,2,3 ]); // RangeInclusive

I know you copied these from the existing examples, but I wonder if we
should eliminate the extra spacing, since it's not idiomatic Rust. Hmm

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/rust-lang/rust/pull/35759/files/7564da22d890784af83bcdebac404c2d6d674bf7#r75185100,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AGfGaWOEno8eN_VLR0fTdvOGkxKdZBxTks5qg1oVgaJpZM4JmxaP
.

This documents unstable syntax, so if we want to do that it needs #![feature(inclusive_range_syntax)].

Added, thank you.

steveklabnik · 2016-08-18T18:20:47Z

https://github.com/rust-lang/rust/pull/35759/files#diff-0283b5f16e1f7cf368f3f56668838f4bR1519

should be below https://github.com/rust-lang/rust/pull/35759/files#diff-0283b5f16e1f7cf368f3f56668838f4bR1523

and similar with all the other examples

matthew-piziak · 2016-08-19T14:54:42Z

^ done. Thanks!

steveklabnik · 2016-08-19T17:41:47Z

@bors: r+ rollup

bors · 2016-08-19T17:41:48Z

📌 Commit 9542d11 has been approved by steveklabnik

Rollup of 19 pull requests - Successful merges: #35234, #35701, #35709, #35710, #35775, #35778, #35780, #35781, #35794, #35800, #35804, #35806, #35811, #35812, #35818, #35827, #35830, #35831, #35839 - Failed merges: #35759

bors · 2016-08-20T18:32:51Z

☔ The latest upstream changes (presumably #35857) made this pull request unmergeable. Please resolve the merge conflicts.

steveklabnik · 2016-08-25T19:34:51Z

@bors: r+ rollup

bors · 2016-08-25T19:34:52Z

📌 Commit 711333f has been approved by steveklabnik

…les, r=steveklabnik refactor range examples This pull request adds a module-level example of how all the range operators work. It also slims down struct-level examples in lieu of a link to module examples.

Rollup of 16 pull requests - Successful merges: #35418, #35759, #35862, #35863, #35895, #35962, #35977, #35993, #35997, #36054, #36056, #36060, #36086, #36100, #36103, #36125 - Failed merges: #35771, #35810

TimNN · 2016-08-30T07:44:14Z

This PR fails linkchecker (see rollup #36126):

core/ops/enum.RangeInclusive.html:84: directory link - core
core/ops/struct.Range.html:76: directory link - core
core/ops/struct.RangeFrom.html:80: directory link - core
core/ops/struct.RangeFull.html:85: directory link - core
core/ops/struct.RangeTo.html:74: directory link - core
core/ops/struct.RangeToInclusive.html:78: directory link - core
std/ops/enum.RangeInclusive.html:84: directory link - std
std/ops/struct.Range.html:76: directory link - std
std/ops/struct.RangeFrom.html:80: directory link - std
std/ops/struct.RangeFull.html:85: directory link - std
std/ops/struct.RangeTo.html:74: directory link - std
std/ops/struct.RangeToInclusive.html:78: directory link - std

To quote a comment from linkchecker:

Links to directories show as directory listings when viewing the docs offline so it's best to avoid them.

GuillaumeGomez · 2016-08-30T08:38:41Z

@bors: r-

Rollup of 16 pull requests - Successful merges: #35418, #35759, #35862, #35863, #35895, #35962, #35977, #35993, #35997, #36054, #36056, #36060, #36086, #36100, #36103, #36125 - Failed merges: #35771, #35810

bors · 2016-08-30T17:16:33Z

☔ The latest upstream changes (presumably #36126) made this pull request unmergeable. Please resolve the merge conflicts.

This pull request adds a module-level example of how all the range operators work. It also slims down struct-level examples in lieu of a link to module examples. add feature for inclusive_range_syntax fix incorrectly closed code fences

steveklabnik · 2016-09-01T21:12:06Z

Travis looks spurious, let's give it a try with bors.

@bors: r+ rollup

bors · 2016-09-01T21:12:08Z

📌 Commit 34be21d has been approved by steveklabnik

…les, r=steveklabnik refactor range examples This pull request adds a module-level example of how all the range operators work. It also slims down struct-level examples in lieu of a link to module examples.

frewsxcv · 2016-09-02T18:57:27Z

Fails tests:

failures:
---- ops::RangeToInclusive_2 stdout ----
    error: inclusive range syntax is experimental (see issue #28237)
 --> <anon>:5:17
  |
5 | assert_eq!(arr[ ...2], [0, 1, 2]);
  |                 ^^^^
  |
  = help: add #![feature(inclusive_range_syntax)] to the crate attributes to enable
error: aborting due to previous error(s)
thread 'ops::RangeToInclusive_2' panicked at 'Box<Any>', src/librustc/session/mod.rs:170
note: Run with `RUST_BACKTRACE=1` for a backtrace.
failures:
    ops::RangeToInclusive_2
test result: FAILED. 1051 passed; 1 failed; 12 ignored; 0 measured
error: test failed

sophiajt · 2016-09-02T19:22:55Z

@bors r-

Pulling it out for #35759 (comment) (and so I can re-roll the rollup). Once fixed we can re-approve and put it back into the queue.

durka · 2016-09-02T20:51:25Z

src/libcore/ops.rs

@@ -2192,11 +2219,13 @@ impl<Idx: PartialOrd<Idx>> RangeInclusive<Idx> {
 /// array elements up to and including the index indicated by `end`.
 ///
 /// ```
-/// #![feature(inclusive_range_syntax)]


This line shouldn't have been removed.

TimNN · 2016-09-03T14:58:06Z

I'm pretty sure that this will fail tidy since directory links are used (ie. ../#Examples instead of ../index.html#Examples. (Also, the correct anchor is #examples, at least in chrome the matching seems to be case sensitive).

matthew-piziak · 2016-09-03T21:54:12Z

Alas, local make tidy is quite noisy for me.

TimNN · 2016-09-03T22:01:46Z

Sorry, it's actually linkchecker (and not tidy) that complains (which only runs when using rustbuild). You can however see the current failures on travis (at the very end) (I would paste them here, put apparently iOS/Safari is not capable of copying from large plaintext files).

frewsxcv · 2016-09-03T23:40:26Z

Linkcheck stage2 (x86_64-unknown-linux-gnu)
core/ops/struct.RangeToInclusive.html:95: directory link - core
core/ops/struct.RangeFull.html:85: directory link - core
core/ops/struct.RangeTo.html:90: directory link - core
core/ops/struct.Range.html:76: directory link - core
core/ops/enum.RangeInclusive.html:84: directory link - core
core/ops/struct.RangeFrom.html:80: directory link - core
std/ops/struct.RangeToInclusive.html:95: directory link - std
std/ops/struct.RangeFull.html:85: directory link - std
std/ops/struct.RangeTo.html:90: directory link - std
std/ops/struct.Range.html:76: directory link - std
std/ops/enum.RangeInclusive.html:84: directory link - std
std/ops/struct.RangeFrom.html:80: directory link - std
thread 'main' panicked at 'found some broken links', src/tools/linkchecker/main.rs:54
note: Run with `RUST_BACKTRACE=1` for a backtrace.


command did not execute successfully: "/build/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/release/linkchecker" "/build/build/x86_64-unknown-linux-gnu/doc"
expected success, got: exit code: 101

frewsxcv · 2016-09-19T23:58:59Z

Linkcheck stage2 (x86_64-unknown-linux-gnu)
core/ops/struct.RangeToInclusive.html:95: broken link fragment  `#examples` pointing to `core/index.html`
core/ops/struct.RangeFull.html:85: broken link fragment  `#examples` pointing to `core/index.html`
core/ops/struct.RangeTo.html:90: broken link fragment  `#examples` pointing to `core/index.html`
core/ops/struct.Range.html:76: broken link fragment  `#examples` pointing to `core/index.html`
core/ops/enum.RangeInclusive.html:84: broken link fragment  `#examples` pointing to `core/index.html`
core/ops/struct.RangeFrom.html:80: broken link fragment  `#examples` pointing to `core/index.html`
std/ops/struct.RangeToInclusive.html:95: broken link fragment  `#examples` pointing to `std/index.html`
std/ops/struct.RangeFull.html:85: broken link fragment  `#examples` pointing to `std/index.html`
std/ops/struct.RangeTo.html:90: broken link fragment  `#examples` pointing to `std/index.html`
std/ops/struct.Range.html:76: broken link fragment  `#examples` pointing to `std/index.html`
std/ops/enum.RangeInclusive.html:84: broken link fragment  `#examples` pointing to `std/index.html`
std/ops/struct.RangeFrom.html:80: broken link fragment  `#examples` pointing to `std/index.html`
thread 'main' panicked at 'found some broken links', src/tools/linkchecker/main.rs:54
note: Run with `RUST_BACKTRACE=1` for a backtrace.

steveklabnik · 2016-09-30T17:37:20Z

@matthew-piziak ping! any interest in keeping up with this PR?

bors · 2016-09-30T21:34:12Z

☔ The latest upstream changes (presumably #36864) made this pull request unmergeable. Please resolve the merge conflicts.

matthew-piziak · 2016-10-03T14:46:12Z

@steveklabnik Sorry, I've been traveling for the past three weeks. I should be back in the game around 7 October. Right now this PR is soft-blocking on #36417. Feel free to close; I'll keep the branch alive on my fork.

steveklabnik · 2016-10-03T15:39:43Z

@matthew-piziak no problem, since it's blocked on something else, and you're willing to keep the branch going, let's close it for now so that I don't have to remember that every time I look through the queue. Safe travels!

rust-highfive assigned alexcrichton Aug 17, 2016

rust-highfive assigned steveklabnik and unassigned alexcrichton Aug 17, 2016

steveklabnik reviewed Aug 17, 2016
View reviewed changes

sophiajt mentioned this pull request Aug 19, 2016

Rollup of 19 pull requests #35834

Closed

sophiajt mentioned this pull request Aug 20, 2016

Rollup of 21 pull requests #35846

Closed

sophiajt mentioned this pull request Aug 20, 2016

Rollup of 19 pull requests #35857

Merged

matthew-piziak force-pushed the refactor-range-examples branch 2 times, most recently from 25886a0 to 31b7ff4 Compare August 22, 2016 21:03

steveklabnik mentioned this pull request Aug 25, 2016

Rollup of 11 pull requests #35994

Closed

steveklabnik mentioned this pull request Aug 26, 2016

Rollup of 11 pull requests #36012

Closed

GuillaumeGomez mentioned this pull request Aug 30, 2016

Rollup of 16 pull requests #36126

Merged

matthew-piziak added 3 commits August 30, 2016 16:30

refactor range examples

7782838

This pull request adds a module-level example of how all the range operators work. It also slims down struct-level examples in lieu of a link to module examples. add feature for inclusive_range_syntax fix incorrectly closed code fences

add fn main wrappers to enable Rust Playground "Run" button

c330046

add a note that whitespace alignment is nonidiomatic

34be21d

matthew-piziak force-pushed the refactor-range-examples branch from 711333f to 34be21d Compare August 30, 2016 20:33

sophiajt mentioned this pull request Sep 2, 2016

Rollup of 13 pull requests #36220

Closed

durka reviewed Sep 2, 2016
View reviewed changes

restored inclusive_range_syntax flag

520b67a

replace ../#Examples with ../index.html#examples

6e38784

matthew-piziak mentioned this pull request Sep 12, 2016

Documentation links are difficult #36417

Closed

steveklabnik closed this Oct 3, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor range examples #35759

refactor range examples #35759

matthew-piziak commented Aug 17, 2016

rust-highfive commented Aug 17, 2016

matthew-piziak commented Aug 17, 2016

steveklabnik Aug 17, 2016

matthew-piziak Aug 17, 2016

durka Aug 18, 2016

matthew-piziak Aug 18, 2016

steveklabnik commented Aug 18, 2016

matthew-piziak commented Aug 19, 2016

steveklabnik commented Aug 19, 2016

bors commented Aug 19, 2016

bors commented Aug 20, 2016

steveklabnik commented Aug 25, 2016

bors commented Aug 25, 2016

TimNN commented Aug 30, 2016

GuillaumeGomez commented Aug 30, 2016

bors commented Aug 30, 2016

steveklabnik commented Sep 1, 2016

bors commented Sep 1, 2016

frewsxcv commented Sep 2, 2016

sophiajt commented Sep 2, 2016

durka Sep 2, 2016

TimNN commented Sep 3, 2016

matthew-piziak commented Sep 3, 2016

TimNN commented Sep 3, 2016

frewsxcv commented Sep 3, 2016

frewsxcv commented Sep 19, 2016

steveklabnik commented Sep 30, 2016

bors commented Sep 30, 2016

matthew-piziak commented Oct 3, 2016

steveklabnik commented Oct 3, 2016

refactor range examples #35759

refactor range examples #35759

Conversation

matthew-piziak commented Aug 17, 2016

rust-highfive commented Aug 17, 2016

matthew-piziak commented Aug 17, 2016

steveklabnik Aug 17, 2016

Choose a reason for hiding this comment

matthew-piziak Aug 17, 2016

Choose a reason for hiding this comment

durka Aug 18, 2016

Choose a reason for hiding this comment

matthew-piziak Aug 18, 2016

Choose a reason for hiding this comment

steveklabnik commented Aug 18, 2016

matthew-piziak commented Aug 19, 2016

steveklabnik commented Aug 19, 2016

bors commented Aug 19, 2016

bors commented Aug 20, 2016

steveklabnik commented Aug 25, 2016

bors commented Aug 25, 2016

TimNN commented Aug 30, 2016

GuillaumeGomez commented Aug 30, 2016

bors commented Aug 30, 2016

steveklabnik commented Sep 1, 2016

bors commented Sep 1, 2016

frewsxcv commented Sep 2, 2016

sophiajt commented Sep 2, 2016

durka Sep 2, 2016

Choose a reason for hiding this comment

TimNN commented Sep 3, 2016

matthew-piziak commented Sep 3, 2016

TimNN commented Sep 3, 2016

frewsxcv commented Sep 3, 2016

frewsxcv commented Sep 19, 2016

steveklabnik commented Sep 30, 2016

bors commented Sep 30, 2016

matthew-piziak commented Oct 3, 2016

steveklabnik commented Oct 3, 2016