Skip to content
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

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

Open
Wizarth opened this issue Aug 14, 2021 · 2 comments
Open

Comments

@Wizarth
Copy link

Wizarth commented Aug 14, 2021

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
Copy link
Member

sjkelly commented Aug 15, 2021

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
Copy link
Author

Wizarth commented Aug 22, 2021

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

sjkelly added a commit that referenced this issue Sep 1, 2021
Correct uvtype -> uv in mesh, partial for #152
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

No branches or pull requests

2 participants