-
-
Notifications
You must be signed in to change notification settings - Fork 36.1k
Docs: Some Geometries were missing mention of parameters property #14260
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
| <h3>.parameters</h3> | ||
| <p> | ||
| Each of the constructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry. | ||
| Each of the contructor parameters is accessible in the parameters property of the object. Any modification of these properties after instantiation does not change the geometry. |
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.
It should be constructor.
|
Hmmm there's a lot more of these than I initially found. Will fix the others too. |
|
|
||
| <h2>Properties</h2> | ||
|
|
||
| <h3>.parameters</h3> |
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.
Is there are reason why you have added this line only in certain files? It would be consistent if you apply this change to all geometry pages. Same for the subsequent description.
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.
I've made it more consistent now. Also for the subsequent description. From cursory browsing .parameters is mentioned in the other Geometry classes, in a slightly different way. I just found + replaced the ones that were all using the same wording.
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.
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.
There are still pages like CircleGeometry that don't have any docs about their parameters. Besides, the formatting of parameters should be similar to the one in DodecahedronGeometry.
<h3>[property:Object parameters]</h3>In this way it is more consistent to the rest of the docs.
…not explicitly mentioned
|
I've updated each geometry doc to mention the This excludes |
|
Fantastic! 👍 |
|
Cheers, have a good weekend :) |
|
Thanks! |
Fixes some cases where the parameters property of a Geometry class was not explicitly mentioned