Terms
Description
The function names in the library currently use plural forms to emphasize support for broadcasting arrays. However, this can sometimes conflict with some input arguments that are, by design, must be plural by default.
One good example is triangles_visible_from_vertices: the num_triangles axis is very important since it represent on "mesh", where triangles can shadow themselves. However, passing one or multiple vertices doesn't change the output, since it simply vectorizes the function for every vertex. Hence, the name could become triangles_visible_from_vertex.
Similarly, we could have:
rays_intersect_any_triangle become ray_intersect_any_triangle (here, any implies reduction on multiple triangles);first_triangles_hit_by_rays become first_triangle_hit_by_ray;refractive_indices become refractive_index;- etc.
Things to do:
- Rename functions and update references to those functions;
- Document breaking changes in
CHANGELOG.md;
- Update docstrings to use proper singular / plural form when relevant.
Screenshots
No response
Additional information
No response
Terms
Description
The function names in the library currently use plural forms to emphasize support for broadcasting arrays. However, this can sometimes conflict with some input arguments that are, by design, must be plural by default.
One good example is
triangles_visible_from_vertices: thenum_trianglesaxis is very important since it represent on "mesh", where triangles can shadow themselves. However, passing one or multiple vertices doesn't change the output, since it simply vectorizes the function for every vertex. Hence, the name could becometriangles_visible_from_vertex.Similarly, we could have:
rays_intersect_any_trianglebecomeray_intersect_any_triangle(here, any implies reduction on multiple triangles);first_triangles_hit_by_raysbecomefirst_triangle_hit_by_ray;refractive_indicesbecomerefractive_index;Things to do:
CHANGELOG.md;Screenshots
No response
Additional information
No response