Improvements to `BTreeSet` documentation. #38208

frewsxcv · 2016-12-07T01:48:14Z

No description provided.

frewsxcv · 2016-12-07T01:51:33Z

GuillaumeGomez

Just a few nits and should be good to go!

GuillaumeGomez · 2016-12-07T02:21:10Z

src/libcollections/btree/set.rs

@@ -74,53 +74,91 @@ pub struct BTreeSet<T> {
    map: BTreeMap<T, ()>,
 }

-/// An iterator over a BTreeSet's items.
+/// An iterator over a `BTreeSet`'s items.


a BTreeSet's itemS?

EDIT: Actually, it can be understood differently. Well, leaving this comment here anyway.

GuillaumeGomez · 2016-12-07T02:22:52Z

src/libcollections/btree/set.rs

-/// An iterator over a BTreeSet's items.
+/// An iterator over a `BTreeSet`'s items.
+///
+/// This structure is created by the [`iter`] method on [`BTreeSet`].


GuillaumeGomez · 2016-12-07T02:23:05Z

src/libcollections/btree/set.rs

-/// An owning iterator over a BTreeSet's items.
+/// An owning iterator over a `BTreeSet`'s items.
+///
+/// This structure is created by the [`into_iter`] method on [`BTreeSet`]


"into_iter()"

GuillaumeGomez · 2016-12-07T02:23:13Z

src/libcollections/btree/set.rs

-/// An iterator over a sub-range of BTreeSet's items.
+/// An iterator over a sub-range of `BTreeSet`'s items.
+///
+/// This structure is created by the [`range`] method on [`BTreeSet`].


GuillaumeGomez · 2016-12-07T02:23:22Z

src/libcollections/btree/set.rs

 pub struct Range<'a, T: 'a> {
    iter: ::btree_map::Range<'a, T, ()>,
 }

 /// A lazy iterator producing elements in the set difference (in-order).
+///
+/// This structure is created by the [`difference`] method on [`BTreeSet`].


"difference()"

GuillaumeGomez · 2016-12-07T02:23:31Z

src/libcollections/btree/set.rs

 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct Difference<'a, T: 'a> {
    a: Peekable<Iter<'a, T>>,
    b: Peekable<Iter<'a, T>>,
 }

 /// A lazy iterator producing elements in the set symmetric difference (in-order).
+///
+/// This structure is created by the [`symmetric_difference`] method on


"symmetric_difference()"

GuillaumeGomez · 2016-12-07T02:23:40Z

src/libcollections/btree/set.rs

 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct SymmetricDifference<'a, T: 'a> {
    a: Peekable<Iter<'a, T>>,
    b: Peekable<Iter<'a, T>>,
 }

 /// A lazy iterator producing elements in the set intersection (in-order).
+///
+/// This structure is created by the [`intersection`] method on [`BTreeSet`].


"intersection()"

GuillaumeGomez · 2016-12-07T02:23:48Z

src/libcollections/btree/set.rs

 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct Intersection<'a, T: 'a> {
    a: Peekable<Iter<'a, T>>,
    b: Peekable<Iter<'a, T>>,
 }

 /// A lazy iterator producing elements in the set union (in-order).
+///
+/// This structure is created by the [`union`] method on [`BTreeSet`].


frewsxcv · 2016-12-07T03:04:44Z

Comments have been addressed.

GuillaumeGomez · 2016-12-07T08:21:36Z

Thanks! I think one commit would have been more than enough here, but whatever! :p

@bors: r+ rollup

bors · 2016-12-07T08:21:37Z

📌 Commit 4983cce has been approved by GuillaumeGomez

frewsxcv · 2016-12-07T16:48:19Z

@bors r-

Looks like there are link errors

frewsxcv · 2016-12-07T16:52:46Z

I think I fixed the links. Will wait for Travis.

GuillaumeGomez · 2016-12-07T18:42:08Z

Seems not. ;)

frewsxcv · 2016-12-07T18:53:25Z

@GuillaumeGomez Can you find the error in the logs? I can't seem to find it. Maybe I'll force push.

Rollup of 9 pull requests - Successful merges: #38085, #38123, #38151, #38153, #38158, #38163, #38186, #38189, #38208 - Failed merges:

GuillaumeGomez · 2016-12-07T23:10:05Z

Didn't find it either. I restarted the build.

goffrie · 2016-12-08T07:20:29Z

src/libcollections/btree/set.rs

+/// An owning iterator over a `BTreeSet`'s items.
+///
+/// This structure is created by the [`into_iter()`] method on [`BTreeSet`]
+/// [`BTreeSet`] (provided by the [`IntoIterator`] trait).


Am I misunderstanding the syntax or are there two BTreeSets in a row here?

If one writes:

```rust [`BTreeSet`] (hello world) [`BTreeSet`]: https://google.com ```

rustdoc will treat this as a link to the url "https://hello world" which is not what we want. Instead, we have to write

```rust [`BTreeSet`][`BTreeSet`] (hello world) [`BTreeSet`]: https://google.com ```

which will link to https://google.com

frewsxcv · 2016-12-09T07:31:28Z

I don't see any errors, so I'm going to consider the links to be fixed.

@bors r=GuillaumeGomez rollup

bors · 2016-12-09T07:31:29Z

📌 Commit 457c282 has been approved by GuillaumeGomez

…omez Improvements to `BTreeSet` documentation. None

frewsxcv · 2016-12-12T17:28:53Z

@bors r-

Linkcheck stage2 (x86_64-pc-windows-msvc)
collections\btree_set\struct.IntoIter.html:53: broken link - iter\trait.IntoIterator.html
collections\btree_set\struct.IntoIter.html:53: broken link - iter\trait.IntoIterator.html

bors · 2016-12-16T11:49:35Z

⌛ Testing commit b4ed584 with merge 318c412...

bors · 2016-12-16T11:51:40Z

💔 Test failed - auto-mac-64-opt-rustbuild

GuillaumeGomez · 2016-12-16T15:47:20Z

You broke the CI again. :p

failures:

---- hash::BuildHasherDefault_0 stdout ----
	error[E0412]: type name `SomeHasher` is undefined or not in scope
  --> <anon>:22:41
   |
22 | type MyBuildHasher = BuildHasherDefault<SomeHasher>;
   |                                         ^^^^^^^^^^ undefined or not in scope
   |
   = help: no candidates by the name of `SomeHasher` found in your project; maybe you misspelled the name or forgot to import an external crate?

error[E0412]: type name `SomeBuidHasher` is undefined or not in scope
  --> <anon>:24:36
   |
24 | let hash_map = HashMap::<u32, u32, SomeBuidHasher>::default();
   |                                    ^^^^^^^^^^^^^^ undefined or not in scope
   |
   = help: no candidates by the name of `SomeBuidHasher` found in your project; maybe you misspelled the name or forgot to import an external crate?

error: aborting due to previous error(s)

thread 'hash::BuildHasherDefault_0' panicked at 'Box<Any>', C:\bot\slave\auto-win-msvc-32-opt\build\src\librustc\session/mod.rs:201
note: Run with `RUST_BACKTRACE=1` for a backtrace.


failures:
    hash::BuildHasherDefault_0

test result: FAILED. 1074 passed; 1 failed; 12 ignored; 0 measured

@bors: r-

frewsxcv · 2016-12-19T08:01:05Z

@bors retry

frewsxcv · 2016-12-19T08:01:16Z

@bors r=GuillaumeGomez

bors · 2016-12-19T08:01:17Z

📌 Commit b4ed584 has been approved by GuillaumeGomez

frewsxcv · 2016-12-19T08:01:29Z

@GuillaumeGomez The error you pasted isn't for my latest commit.

alexcrichton · 2016-12-20T18:41:25Z

@bors: r=GuillaumeGomez

bors · 2016-12-20T18:41:26Z

💡 This pull request was already approved, no need to approve it again.

This pull request previously failed. You should add more commits to fix the bug, or use retry to trigger a build again.
There's another pull request that is currently being tested, blocking this pull request: resolve: change most backwards incompatible ambiguity errors to legacy_imports warnings #38271

bors · 2016-12-20T18:41:26Z

📌 Commit b4ed584 has been approved by GuillaumeGomez

alexcrichton · 2016-12-20T18:42:30Z

Hm bors doesn't seem to want to move this out of the failed state. I'm going to close and reopen to see if that works.

alexcrichton · 2016-12-20T18:42:44Z

@bors: r+

bors · 2016-12-20T18:42:45Z

💡 This pull request was already approved, no need to approve it again.

This pull request previously failed. You should add more commits to fix the bug, or use retry to trigger a build again.
There's another pull request that is currently being tested, blocking this pull request: resolve: change most backwards incompatible ambiguity errors to legacy_imports warnings #38271

bors · 2016-12-20T18:42:45Z

📌 Commit b4ed584 has been approved by alexcrichton

alexcrichton · 2016-12-20T18:43:21Z

@frewsxcv looks like bors is getting confused here unfortunately. Want to commit --amend and force push the most recent commit to generate a new commit sha? I think that'll kick bors into seeing something different and re-approving.

Fixes rust-lang#38204.

frewsxcv · 2016-12-20T18:45:00Z

Done.

alexcrichton · 2016-12-20T18:45:52Z

@bors: r+

bors · 2016-12-20T18:45:52Z

📌 Commit fe0d092 has been approved by alexcrichton

alexcrichton · 2016-12-20T18:46:11Z

Looks like that did the trick!

Improvements to `BTreeSet` documentation. None

Rollup of 29 pull requests - Successful merges: #37761, #38006, #38131, #38150, #38158, #38171, #38208, #38215, #38236, #38245, #38289, #38302, #38315, #38346, #38388, #38395, #38398, #38418, #38432, #38451, #38463, #38468, #38470, #38471, #38472, #38478, #38486, #38493, #38498 - Failed merges: #38271, #38483

frewsxcv mentioned this pull request Dec 7, 2016

Are BTreeSet iterators guaranteed to visit elements in ascending order? #38204

Closed

frewsxcv force-pushed the btreesetdocs branch from 2e7deb7 to dfd8739 Compare December 7, 2016 01:48

rust-highfive assigned GuillaumeGomez Dec 7, 2016

GuillaumeGomez requested changes Dec 7, 2016

View reviewed changes

frewsxcv force-pushed the btreesetdocs branch from dfd8739 to 4983cce Compare December 7, 2016 03:04

GuillaumeGomez mentioned this pull request Dec 7, 2016

Rollup of 9 pull requests #38214

Merged

GuillaumeGomez approved these changes Dec 7, 2016

View reviewed changes

frewsxcv force-pushed the btreesetdocs branch from 4983cce to a4fcd79 Compare December 7, 2016 16:52

frewsxcv force-pushed the btreesetdocs branch from a4fcd79 to 5ef15ef Compare December 7, 2016 18:56

bors added a commit that referenced this pull request Dec 7, 2016

Auto merge of #38214 - GuillaumeGomez:rollup, r=GuillaumeGomez

535b6d3

Rollup of 9 pull requests - Successful merges: #38085, #38123, #38151, #38153, #38158, #38163, #38186, #38189, #38208 - Failed merges:

frewsxcv force-pushed the btreesetdocs branch from 5ef15ef to 457c282 Compare December 7, 2016 20:48

goffrie reviewed Dec 8, 2016

View reviewed changes

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Dec 12, 2016

Rollup merge of rust-lang#38208 - frewsxcv:btreesetdocs, r=GuillaumeG…

68654b9

…omez Improvements to `BTreeSet` documentation. None

frewsxcv mentioned this pull request Dec 12, 2016

Rollup of 8 pull requests #38320

Closed

Indicate BTreeSet in docs is code-like.

cf56c1f

GuillaumeGomez mentioned this pull request Dec 16, 2016

Rollup of 7 pull requests #38407

Closed

alexcrichton closed this Dec 20, 2016

alexcrichton reopened this Dec 20, 2016

Indicate that BTreeSet::iter returns values in ascending order.

fe0d092

Fixes rust-lang#38204.

frewsxcv force-pushed the btreesetdocs branch from b4ed584 to fe0d092 Compare December 20, 2016 18:44

alexcrichton added a commit to alexcrichton/rust that referenced this pull request Dec 20, 2016

Rollup merge of rust-lang#38208 - frewsxcv:btreesetdocs, r=alexcrichton

b070feb

Improvements to `BTreeSet` documentation. None

alexcrichton mentioned this pull request Dec 20, 2016

Rollup of 29 pull requests #38499

Merged

bors merged commit fe0d092 into rust-lang:master Dec 21, 2016

Improvements to BTreeSet documentation. #38208

Improvements to BTreeSet documentation. #38208

Conversation

frewsxcv commented Dec 7, 2016

frewsxcv commented Dec 7, 2016

GuillaumeGomez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frewsxcv commented Dec 7, 2016

GuillaumeGomez commented Dec 7, 2016

bors commented Dec 7, 2016

frewsxcv commented Dec 7, 2016

frewsxcv commented Dec 7, 2016

GuillaumeGomez commented Dec 7, 2016

frewsxcv commented Dec 7, 2016

GuillaumeGomez commented Dec 7, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frewsxcv commented Dec 9, 2016

bors commented Dec 9, 2016

frewsxcv commented Dec 12, 2016

bors commented Dec 16, 2016

bors commented Dec 16, 2016

GuillaumeGomez commented Dec 16, 2016 • edited Loading

frewsxcv commented Dec 19, 2016

frewsxcv commented Dec 19, 2016

bors commented Dec 19, 2016

frewsxcv commented Dec 19, 2016

alexcrichton commented Dec 20, 2016

bors commented Dec 20, 2016

bors commented Dec 20, 2016

alexcrichton commented Dec 20, 2016

alexcrichton commented Dec 20, 2016

bors commented Dec 20, 2016

bors commented Dec 20, 2016

alexcrichton commented Dec 20, 2016

frewsxcv commented Dec 20, 2016

alexcrichton commented Dec 20, 2016

bors commented Dec 20, 2016

alexcrichton commented Dec 20, 2016

Improvements to `BTreeSet` documentation. #38208

Improvements to `BTreeSet` documentation. #38208

GuillaumeGomez commented Dec 16, 2016 •

edited

Loading