-
Notifications
You must be signed in to change notification settings - Fork 111
Add documentation to transform_inclusive_scan and transform_exclusive_scan #103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You also need to remove transform_inclusive_scan from https://github.com/boostorg/algorithm/blob/develop/doc/algorithm.qbk#L238
i.e. The section named Not-yet-documented C++17 Algorithms
Also, please lose the "sparkles" and other emoji in the commit messages.
1c917b4
to
97284c7
Compare
Hi @glenfe - Thanks for the feedback - I hadn't yet noticed the "Not-yet documented" section of that quickbook. Please let me know if there are any other changes I can make to help this land. |
Thanks @jgopel . This looks better now. To be complete, it should probably also add sections for the now documented functions in the i.e. In this block: https://github.com/boostorg/algorithm/blob/develop/doc/algorithm.qbk#L100-L109 we need something like:
And a similar section for |
2620876
to
d2ffff4
Compare
Done 🙂 Based on the existing entries in the quickbook, I kept the description a little shorter there and left the longer description for the linked page. If you'd prefer a different approach, just say the word! |
Problem: - There is no documentation for the existing functions. This will make it harder for users to consume these functions, especially as new variants are added. Solution: - Add documentation.
d2ffff4
to
533856f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me now - thanks.
Problem: - There is no documentation for the existing functions. This will make it harder for users to consume these functions, espcially as new variants are added. Solution: - Add documentation.
533856f
to
6b7a38f
Compare
No description provided.