Documentation: spelling, grammar, and clarity #1109
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Minor grammar and spelling.
The description of the function "exp" erroneously referred to "x" rather than "v". Rectified.
Tachi107
reviewed
Sep 20, 2022
| @@ -89,7 +89,7 @@ | |||
| Functions</h2></td></tr> | |||
| <tr class="memitem:ga071566cadc7505455e611f2a0353f4d4"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |||
| <tr class="memitem:ga071566cadc7505455e611f2a0353f4d4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00242.html#ga071566cadc7505455e611f2a0353f4d4">exp</a> (vec< L, T, Q > const &v)</td></tr> | |||
| <tr class="memdesc:ga071566cadc7505455e611f2a0353f4d4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the natural exponentiation of x, i.e., e^x. <a href="a00242.html#ga071566cadc7505455e611f2a0353f4d4">More...</a><br /></td></tr> | |||
| <tr class="memdesc:ga071566cadc7505455e611f2a0353f4d4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the natural exponentiation of v, i.e., e^v. <a href="a00242.html#ga071566cadc7505455e611f2a0353f4d4">More...</a><br /></td></tr> | |||
There was a problem hiding this comment.
The content of the doc/api/ directory is generated by Doxygen; you should fix the comment in the actual source, and then regenerate the documentation. The typo is here:
Line 38 in cc98465
There was a problem hiding this comment.
Thanks for pointing that out. I'll change it under glm/glm/exponential.hpp as you pointed out.
Earlier I made the change in the html generated by doxygen rather than the source used to generate the documentation.
|
Thanks for contributing! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Modified Readme to fix some typos.
Modified HTML doc to make function description more accurate.