Add a rustdoc test for union to exhibit how it is used. #19488
Conversation
|
@alexcrichton can I add doctests for |
|
Feel free to add it here, feel free to ping me when this is updated, thanks @jbranchaud! |
|
@alexcrichton I've added doctests for |
|
Thanks @jbranchaud! |
|
@alexcrichton no problem! It is fun being able to learn Rust and contribute to it at the same time. |
| /// let mut diff = a.difference(&b); | ||
| /// | ||
| /// assert_eq!(*diff.next().unwrap(), 1u); | ||
| /// assert_eq!(diff.next(), None); |
There was a problem hiding this comment.
Late to the party, but I wonder if these would be cleaner and/or more clear if they were .collect()ed into a Vec on-which we run the comparison?
There was a problem hiding this comment.
@gankro I can do that. I was actually just noticing that that is more or less what is done for corresponding methods of some of the other data structures.
Add a rustdoc test for union to exhibit how it is used. There is already a test for union in the test namespace, but this commit adds a doctest that will appear in the rustdocs. Add a doctest for the difference function. Add a doctest for the symmetric_difference function. Add a doctest for the intersection function. Update the union et al. doctests based on @gankro's comments. Make the union et al. doctests a bit more readable.
jbranchaud
force-pushed
the
add-btree-set-doctests
branch
from
29578c5 to
451cc7e
Compare
|
I've addressed @gankro's comments and squashed the commits. /cc @alexcrichton |
…crichton There is already a test for `union` in the test namespace, but this commit adds a doctest that will appear in the rustdocs. Someone on IRC said, *Write doctests!*, so here I am. I am not sure this is the best way to demonstrate the behavior of the union function, so I am open to suggestions for improving this. If I am on the right track I'd be glad to include similar doctests for `intersection`, `difference`, etc.
There is already a test for
unionin the test namespace, but this commit adds a doctest that will appear in the rustdocs.Someone on IRC said, Write doctests!, so here I am.
I am not sure this is the best way to demonstrate the behavior of the union function, so I am open to suggestions for improving this. If I am on the right track I'd be glad to include similar doctests for
intersection,difference, etc.