Documentation update for reduce functions, swizzle #273
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's quite a lot to go through. I'm hoping this introductory patch sets something of a style for examples. In general, I tried to copy the style of the
std::vec::Vec
documentation, which I think is quite good.The doc-macros here look a bit crafty, but I think the documentation they generate is very readable. Some examples:
for
reduce_sum
, specialized onu64
:it would have looked cleaner with
i64x2
, but unfortunatelyi8x2
doesn't exist.for
reduce_max
, specialized onf32
:If this looks OK, happy to keep this going in future patches. I think compiling the
beginners-guide.md
into top-level crate documentation would also likely be helpful, because it would give explanations that other documentation could refer to, instead of repeating concepts.