-
-
Notifications
You must be signed in to change notification settings - Fork 182
Cleanup deprecated code and Update documentation for BufferGeometry and BufferAttribute #335
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
Clean up BufferGeometry
Clean up some old classes
|
|
||
| /** | ||
| * This is a superefficent class for geometries because it saves all data in buffers. | ||
| * This is a super efficient class for geometries because it saves all data in buffers. |
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 think it's probably documentation in the era when they used to live together with Geometry.
If you are super generous and change the doc to the latest one I will appreciate it.
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.
Hello @0b5vr, I had already started working on improving TSDocs but I'm coding a way to do mostly automatic allowing update everything quicker. And this will take some time to complete.
So for now I just update the TSDocs for BufferGeometry in a very quick and dirty way. And in the near future, I will update with better TSDocs.
And a fix for all the returning types will be done in another PR.
|
All Documentation is now Updated with the level of quality that I was aiming. |
|
Some return Types were updated with the correct type according to the Documentation and Source code, with more changes that I'm planning for other PR. |
|
Sorry for the late response, I will check it tomorrow! |
0b5vr
left a comment
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.
Looks... fantastic
Thank you!
|
@rafaelsc Seems you have to delete the line You can check locally by doing |
|
Good find. That error started after my last commit when I added the reference for |
Why
BufferGeometry and BufferAttribute type need some cleanup to remove code that doesn't exist anymore on ThreeJS. And even marked was deprecated would cause runtime errors. And some documentation spelling and naming needed improvements.
What
Checklist
master, next goesdev)