JuliaGeometry / GeometryBasics.jl

Basic Geometry Types
MIT License
164 stars 54 forks source link

Documentation: GeometryBasics.mesh docs don't match function signature #152

Open Wizarth opened 3 years ago

Wizarth commented 3 years ago

The documentation for GeometryBasics.mesh function indicates it takes a uvtype keyword parameter, but the implementation takes uv keyword parameter.

Given that all the other keyword parameters are somethingtype, I'd assume it's the function signature that is incorrect.

sjkelly commented 3 years ago

This seems like an inconsistency. It is probably easier to to fix the docs now. We could add a uvtype and make the uv kwarg a deprecation warning until 0.5 or 1.0. I've rarely worked with UVs so I may be missing some mechanics or some implicit typing here, so let's keep this open for more discussion.

Wizarth commented 3 years ago

For an additional data point, MeshIO uses exactly the same keyword parameters, except using uvtype vs uv

https://github.com/JuliaIO/MeshIO.jl/blob/c2f269edacaf70b55c05da1e9b9fad21b0d4ed02/src/io/obj.jl#L7