Clarify the Line2D, Curve2D/3D documentation and fix parameter names
#64439
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
YuriSizov
force-pushed
the
docs-line2d-clarity
branch
from
03d9163
to
fff0e7b
Compare
YuriSizov
changed the title
Line2D documentation and fix parameter namesLine2D, Curve2D/3D documentation and fix parameter names
mhilbrunner
approved these changes
Aug 15, 2022
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.
I noticed a badly formatted method reference at first, and then trying to read the whole thing got confused by the wording too. So I've fixed the language to clarify both the logic of this function, as well as cross-reference, as well as parameter names across several related methods of the class.
The issue was apparently identified the moment this argument was added in #27805, but it was never fixed since.
This fix also applies to
3.x, but it doesn't have the[param foo]syntax (yet?) so it cannot be easily cherrypicked.