Skip to content

Conversation

@taybenlor
Copy link
Contributor

Fixes some cases where the parameters property of a Geometry class was not explicitly mentioned

<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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be constructor.

@taybenlor
Copy link
Contributor Author

Hmmm there's a lot more of these than I initially found. Will fix the others too.


<h2>Properties</h2>

<h3>.parameters</h3>
Copy link
Collaborator

@Mugen87 Mugen87 Jun 9, 2018

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.

Copy link
Contributor Author

@taybenlor taybenlor Jun 9, 2018

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

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.

@Mugen87
Copy link
Collaborator

Mugen87 commented Jun 9, 2018

@taybenlor
Copy link
Contributor Author

I've updated each geometry doc to mention the parameters property in the style you suggested. In cases where there was already a mention I pre-pended the generic descriptor for consistency.

This excludes WireframeGeometry which does not store its geometry parameter.

@Mugen87
Copy link
Collaborator

Mugen87 commented Jun 9, 2018

Fantastic! 👍

@taybenlor
Copy link
Contributor Author

Cheers, have a good weekend :)

@mrdoob mrdoob added this to the r94 milestone Jun 12, 2018
@mrdoob mrdoob merged commit 391017b into mrdoob:dev Jun 12, 2018
@mrdoob
Copy link
Owner

mrdoob commented Jun 12, 2018

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants