search

donmccurdy / glTF-Transform

glTF 2.0 SDK for JavaScript and TypeScript, on Web and Node.js.
https://gltf-transform.dev
MIT License
1.43k stars 150 forks source link

improve dedup doc : default params #1145

Open Makio64 opened 1 year ago

Makio64 commented 1 year ago

Is your feature request related to a problem? Please describe. Improve the documentation of dedup function to specify the property dedup by default : 

        PropertyType.ACCESSOR,
        PropertyType.MESH,
        PropertyType.TEXTURE,
        PropertyType.MATERIAL,
        PropertyType.SKIN,

Describe alternatives you've considered Alternative : also add it to DedupOptions

Additional context While reading the documentation page of dedup, I wasnt sure and went to the source code to double check, I think it can be easily avoid for futur users.

donmccurdy commented 1 year ago

I think greendoc (https://github.com/donmccurdy/greendoc) does not yet support documentation of default parameters, so the feature would need to be added there first.