[docs] modified sentence structure #62772
Conversation
docs/SequencesAndCollections.rst
Outdated
| @@ -55,11 +55,11 @@ represented by the `SequenceType` protocol:: | |||
|
|
|||
| __ http://swiftdoc.org/v3.0/type/AnyIterator/ | |||
|
|
|||
| As you can see, sequence does nothing more than deliver an iterator. | |||
| As you can see, sequence does nothing more than delivering an iterator. | |||
There was a problem hiding this comment.
Is this really a typo? I have a strong feeling that "does" warrants an infinitive.
There was a problem hiding this comment.
While we are here:
| As you can see, sequence does nothing more than delivering an iterator. | |
| As you can see, a sequence does nothing more than delivering an iterator. |
There was a problem hiding this comment.
@AnthonyLatsis Thank you for your comments.
I agree that "does" warrants an infinitive. I thought that the word "deliver" was being emphasized here. For that reason, I believed "delivering" suits better than "deliver".
I find your suggestion makes more sense than mine. I will modify my commit accordingly.
Thank you.
There was a problem hiding this comment.
I agree that "does" warrants an infinitive. I thought that the word "deliver" was being emphasized here. For that reason, I believed "delivering" suits better than "deliver".
I hear you, but we have to be careful not to sacrifice grammar for preference. I am not entirely sure the gerund is inappropriate though; it could be that both fit.
cc @CodaFi
There was a problem hiding this comment.
@AnthonyLatsis Thank you for your opinion. I reverted accordingly. :)
docs/SequencesAndCollections.rst
Outdated
| To understand the need for iterators, it's important to distinguish | ||
| the two kinds of sequences. | ||
|
|
||
| * **Volatile** sequences like "stream of network packets," carry | ||
| * **Volatile** sequences like "stream of network packets", carry |
There was a problem hiding this comment.
Do we even need one here? Two is also fine, but a comma on just one end of the non-restrictive clause distorts the flow.
There was a problem hiding this comment.
@AnthonyLatsis Thank you again for your comment.
I just realized that I omitted comma before "like" in the process of committing. I apologize for the confusion.
I meant to suggest **Volatile** sequences, like "stream of network packets", carry as I thought line 62 was intended to use same sentence structure as line 63.
May I ask for your opinion on this again? Thank you in advance.
There was a problem hiding this comment.
Sounds good to me! Either 2 commas or none is fine.
There was a problem hiding this comment.
@AnthonyLatsis I added 2 commas as we discussed. Would you be able to call smoke test? Thank you and happy new year. :)
|
Happy New Year! Could you squash the changes into a single commit before we invoke the tests? |
teddy5518
changed the title
|
@AnthonyLatsis Hello, I just squashed the changes into single commit. :) |
AnthonyLatsis
added
documentation
standard library
|
@swift-ci please smoke test |
|
@AnthonyLatsis Thank you! Please merge when you get a chance. :) |
Hello,
I was reading through SequencesAndCollections.rst and I have found a stray comma and typo.
Please review. 🐻