-
-
Notifications
You must be signed in to change notification settings - Fork 145
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
Update documentation for ThreeJS scenes and textures Classes, with some Typing improvements #380
Conversation
chore: Code Format
Thanks for working on this! I'm curious what the maintainability of these docs are? Is there a way to make sure they stay up-to-date, or would it just have to be manually updated when changes are made in three.js? Shouldn't block this from merging since having the docs at all is better than not having them since they don't change that often, just curious whether there is a sustainable way to make sure they stay up-to-date. |
Right now the only way to know that is up-to-date is by fowling the ThreeJS changelog on new releases and seeing what documents changed. They do a great job reporting changes in documentation see: https://github.com/mrdoob/three.js/releases/tag/r150 My end goal is to parse and update the TSDocs automatically via a yarn/npm command, but for right now I do not know when I will have time to invest in that. |
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.
Thanks for working on these. I did not thoroughly review the changes, but they're surely better than the status quo, and we can make any adjustments in follow-up PRs if necessary.
@rafaelsc Would you be willing to publish the parser? Some of the changes in docs like mrdoob/three.js#26147 are just not worth my time to update manually, but I share your end goal of doing it all automatically. I have thought about writing a parser as well, but if you already have something started, it'd be great to not to have to start from scratch. |
Why
The TSDocs for many classes are missing or outdated.
Some Typing information is missing and could be improved.
Missing overwriting information in Textures classes.
What
Texture
,format
andmapping
types updated to allow any sub-texture types.format
to be required forCompressedTexture
andCompressedArrayTexture
. Internally the default value is a non-compressed constant fromTexture
and not compatible withCompressedTexture
.Checklist
master
, next goesdev
)