Clarify last element in str.{r,}splitn documentation #36930

angelsl · 2016-10-03T15:54:04Z

An attempt at #36202.

I'm not sure if my wording is actually clearer, to be honest...

rust-highfive · 2016-10-03T15:54:18Z

(rust_highfive has picked a reviewer for you, use r? to override)

frewsxcv · 2016-10-03T21:48:14Z

src/libcollections/str.rs

@@ -1055,8 +1055,8 @@ impl str {
    /// An iterator over substrings of the given string slice, separated by a
    /// pattern, restricted to returning at most `count` items.
    ///
-    /// The last element returned, if any, will contain the remainder of the


I think, as a whole, your changes are an improvement and make it easier to understand this concept.

If a countth substring

I personally stumbled on this though. It took me a few re-reads to understand this is talking about "substring with countth number of items". I can't think of a better suggestion at the moment without making it too verbose. Going to think about this...

For non-english reader, this is particurlarly hard.

How about this:

If count substrings are returned, the last substring i.e. the countth substring will contain the remainder of the string.

I think that's better. Or maybe even:

If count substrings are returned, the last substring (the countth substring) will contain the remainder of the string.

What do you think @GuillaumeGomez ?

Crazy idea: rename the parameter from count to n (slice::splitn's parameter is called n). Then we can say "the nth substring" which is probably easier to parse.

@frewsxcv: I prefer @durka's proposition. :)

I'm generally against single letter variable names, but considering the method name is splitn, I think n makes sense. What do you think @angelsl? If you're alright with it, can you rename the parameter and update the instances of count in the doc comment?

Sounds good to me. I've amended the commit.

frewsxcv · 2016-10-05T16:29:29Z

Looks great, thanks! r=me

GuillaumeGomez · 2016-10-05T18:56:12Z

@bors: r=frewsxcv rollup

bors · 2016-10-05T18:56:13Z

📌 Commit a4e9c39 has been approved by frewsxcv

Clarify last element in str.{r,}splitn documentation An attempt at rust-lang#36202. I'm not sure if my wording is actually clearer, to be honest...

Rollup of 15 pull requests - Successful merges: #36726, #36832, #36909, #36930, #36932, #36957, #36959, #36960, #36962, #36965, #36966, #36967, #36972, #36974, #36977 - Failed merges:

rust-highfive assigned brson Oct 3, 2016

frewsxcv reviewed Oct 3, 2016

View reviewed changes

frewsxcv mentioned this pull request Oct 3, 2016

splitn documentation is not clear #36202

Closed

Clarify last element in str.{r,}splitn documentation

a4e9c39

sophiajt mentioned this pull request Oct 6, 2016

Rollup of 15 pull requests #37002

Merged

bors merged commit a4e9c39 into rust-lang:master Oct 6, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clarify last element in str.{r,}splitn documentation #36930

Clarify last element in str.{r,}splitn documentation #36930

angelsl commented Oct 3, 2016

rust-highfive commented Oct 3, 2016

frewsxcv Oct 3, 2016

GuillaumeGomez Oct 3, 2016

angelsl Oct 4, 2016

frewsxcv Oct 4, 2016

durka Oct 4, 2016

GuillaumeGomez Oct 5, 2016

frewsxcv Oct 5, 2016

angelsl Oct 5, 2016

frewsxcv commented Oct 5, 2016

GuillaumeGomez commented Oct 5, 2016

bors commented Oct 5, 2016

Clarify last element in str.{r,}splitn documentation #36930

Clarify last element in str.{r,}splitn documentation #36930

Conversation

angelsl commented Oct 3, 2016

rust-highfive commented Oct 3, 2016

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 Oct 5, 2016

GuillaumeGomez commented Oct 5, 2016

bors commented Oct 5, 2016