`for_each_n` doc completed (#3933) by BrandonPacewic · Pull Request #3934 · MicrosoftDocs/cpp-docs

BrandonPacewic · 2022-05-30T00:14:41Z

This pr fixes #3933. Adding documentation for the STL algorithm for_each_n.

PRMerger8 · 2022-05-30T00:14:55Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

PRMerger4 · 2022-05-30T00:17:43Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

PRMerger4 · 2022-05-30T00:24:40Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

PRMerger7 · 2022-05-30T01:14:53Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

PRMerger10 · 2022-05-30T13:18:05Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

jborsecnik · 2022-05-30T16:18:15Z

@TylerMSFT,

Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, add a #sign-off comment to signal that the PR is ready for the review team to merge. Thanks.

#label:"aq-pr-triaged"

TylerMSFT · 2022-05-31T17:48:22Z

    // The function object is templatized and so can be
    // used again on the elements with a different Factor
-    for_each (v1.begin( ), v1.end( ), MultValue<int> (5 ) );
+    for_each ( v1.begin( ), v1.end( ), MultValue<int> ( 5 ) );


Hi, our style is to not have the extra spacing between parens.

TylerMSFT

@BrandonPacewic, thank you so much for seeing this hole and patching it up! Really appreciate you improving the docs.
I left some minor comments for you to consider.

TylerMSFT · 2022-05-31T18:19:16Z

+An input iterator addressing the position of the first element in the range to be operated on.
+
+*`count`*\
+A signed or unsigned integral type specifying the number of elements to be operated on.


The detail is correct but it may be more consumable to simply say 'The number of elements to operate on'

strega-nil

(accidentally reviewing from my personal account sorry lol)

strega-nil · 2022-05-31T18:39:42Z

+An iterator to the element that follows the last element processed if *`count`* > zero,
+otherwise the first element.


This is unnecessarily confusing, imo; I would say something more like:

Suggested change

An iterator to the element that follows the last element processed if *`count`* > zero,

otherwise the first element.

The iterator after the last element processed.

Co-authored-by: nicole mazzuca <mazzucan@outlook.com>

PRMerger14 · 2022-05-31T19:11:14Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Co-authored-by: nicole mazzuca <mazzucan@outlook.com>

PRMerger-2 · 2022-05-31T19:13:01Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

BrandonPacewic · 2022-05-31T22:31:52Z

Example looks better now unless anyone has a problem with how I wrote the print_vector function, perhaps it should only expect a vector<int> instead of a templated vector? I avoided the auto keyword but it might make it easier to understand.

The wording I used for the params is almost identical to the fill_n function. Should it be changed to make it easier to read? It is possible that I am making a mistake by trying to use the older documentation as a guide.

TylerMSFT

Hi Brandon,
Thank you for hanging in there on this. Thank you for the updates so far. I agree with the comment Stephan made about the lambdas. I'll watch for the update addressing that, and then we'll see if we can get this through.

Oh, regarding using the older documentation as a guide, yes, things have evolved. The difficulty is that we have hundreds of topics that are older than some of the people who come here to use them. We'd like to update them all, but simply don't have the resources. So, we go through what you are going through now, which is trying to make a little corner of the C++ docs better than it was before :-)

PRMerger12 · 2022-05-31T22:34:08Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

PRMerger20 · 2022-05-31T22:58:36Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

TylerMSFT

@BrandonPacewic, thank you for making this contribution to the docs. I realize that you are doing it out of good will and on your own time. Thank you for improving this doc and participating in going back and forth with us on it.

PRMerger15 · 2022-05-31T23:09:19Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

BrandonPacewic · 2022-05-31T23:09:39Z

That's my last change I promise 😺

TylerMSFT · 2022-05-31T23:10:10Z

#sign-off

BrandonPacewic · 2022-05-31T23:17:31Z

@BrandonPacewic : Thanks for your contribution! The author(s) have been notified to review your proposed change.

I love working on these types of things. It is no burden for me to write back and forth. I sincerely appreciate everyone's willingness to work with me! ❤️

TylerMSFT

Re-approving - getting a request to do so for some reason.

BrandonPacewic · 2022-05-31T23:50:14Z

I made one more commit a few seconds after you approved the changes

TylerMSFT · 2022-05-31T23:52:22Z

#sign-off

PRMerger5 · 2022-06-01T15:21:45Z

@ShannonLeavitt : Thanks for your contribution! The author(s) have been notified to review your proposed change.

wadepickett · 2022-06-01T21:55:32Z

Hey @BrandonPacewic , great work!

BrandonPacewic · 2022-06-01T22:03:19Z

Hey @BrandonPacewic , great work!

Thanks! 😺

TylerMSFT · 2022-06-02T16:59:49Z

@BrandonPacewic , I sent you an e-mail a few minutes ago. Check your junk mail because it'll probably go there :-)

for_each_n doc completed (#3933)

84b6921

PRMerger4 added the do-not-merge label May 30, 2022

PRMerger8 requested a review from TylerMSFT May 30, 2022 00:14

PRMerger8 assigned TylerMSFT May 30, 2022

PRMerger8 added cpp-standard-libraries/tech visual-cpp/prod Change sent to author labels May 30, 2022

Added a space for style consistency

dc6c216

for_each_n summary update (#3933)

c49abaa

for_each_n summary update (#3933)

b1dda12

for_each_n example update (#3933)

dc9b070

PRMerger15 added the aq-pr-triaged Tracking label for the PR review team label May 30, 2022

TylerMSFT reviewed May 31, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md Outdated

TylerMSFT reviewed May 31, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md

TylerMSFT reviewed May 31, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md Outdated

TylerMSFT reviewed May 31, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md Outdated

TylerMSFT requested changes May 31, 2022

View reviewed changes

strega-nil suggested changes May 31, 2022

View reviewed changes

Shorter Remarks

f39cf26

Co-authored-by: nicole mazzuca <mazzucan@outlook.com>

PRMerger14 requested a review from TylerMSFT May 31, 2022 19:11

Shorter Remarks

1c7cd07

Co-authored-by: nicole mazzuca <mazzucan@outlook.com>

TylerMSFT requested changes May 31, 2022

View reviewed changes

for_each_n example update, now using auto

89a1ca0

PRMerger12 requested a review from TylerMSFT May 31, 2022 22:34

TylerMSFT reviewed May 31, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md Outdated

TylerMSFT reviewed May 31, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md Outdated

for_each_n update to example

fd0c089

PRMerger20 requested a review from TylerMSFT May 31, 2022 22:58

TylerMSFT approved these changes May 31, 2022

View reviewed changes

for_each_n example update

4c03f9e

PRMerger15 requested a review from TylerMSFT May 31, 2022 23:09

PRMerger14 added ready-to-merge and removed do-not-merge labels May 31, 2022

TylerMSFT approved these changes May 31, 2022

View reviewed changes

ShannonLeavitt reviewed Jun 1, 2022

View reviewed changes

Comment thread docs/standard-library/algorithm-functions.md Outdated

Update docs/standard-library/algorithm-functions.md

ff95925

PRMerger5 requested a review from TylerMSFT June 1, 2022 15:21

ShannonLeavitt merged commit 7a731cc into MicrosoftDocs:main Jun 1, 2022

		An iterator to the element that follows the last element processed if `count` > zero,
		otherwise the first element.

	An iterator to the element that follows the last element processed if `count` > zero,
	otherwise the first element.
	The iterator after the last element processed.

Conversation

BrandonPacewic commented May 30, 2022

Uh oh!

PRMerger8 commented May 30, 2022

Uh oh!

PRMerger4 commented May 30, 2022

Uh oh!

PRMerger4 commented May 30, 2022

Uh oh!

PRMerger7 commented May 30, 2022

Uh oh!

PRMerger10 commented May 30, 2022

Uh oh!

jborsecnik commented May 30, 2022

Uh oh!

TylerMSFT May 31, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TylerMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

TylerMSFT May 31, 2022

Choose a reason for hiding this comment

Uh oh!

strega-nil left a comment

Choose a reason for hiding this comment

Uh oh!

strega-nil May 31, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PRMerger14 commented May 31, 2022

Uh oh!

PRMerger-2 commented May 31, 2022

Uh oh!

BrandonPacewic commented May 31, 2022

Uh oh!

TylerMSFT left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PRMerger12 commented May 31, 2022

Uh oh!

Uh oh!

Uh oh!

PRMerger20 commented May 31, 2022

Uh oh!

TylerMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

PRMerger15 commented May 31, 2022

Uh oh!

BrandonPacewic commented May 31, 2022

Uh oh!

TylerMSFT commented May 31, 2022

Uh oh!

BrandonPacewic commented May 31, 2022

Uh oh!

TylerMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

BrandonPacewic commented May 31, 2022

Uh oh!

TylerMSFT commented May 31, 2022

Uh oh!

Uh oh!

PRMerger5 commented Jun 1, 2022

Uh oh!

wadepickett commented Jun 1, 2022

Uh oh!

BrandonPacewic commented Jun 1, 2022

Uh oh!

TylerMSFT commented Jun 2, 2022

TylerMSFT left a comment •

edited

Loading