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

Minor docstring/behaviour mismatch in 2D and 3D coordinates/geometries. #3040

Open
OceanNuclear opened this issue Feb 23, 2024 · 0 comments
Open
Labels
bug Something isn't working discussion issue to be converted to a discussion 📜 Papercut Papercut bug

Comments

@OceanNuclear
Copy link
Contributor

OceanNuclear commented Feb 23, 2024

Describe the papercut

The input to bluemira.geometry.coordinates.normal_vector should be of shape (2, N), not (N, 2).

This is so minor that it'll take about 10 seconds to fix. But I just needed to raise a papercut because I'm currently busy working on a branch that I've not committed.

To turn this into a proper papercut, maybe I'll propose one more thing to do/check:

  1. Run grep -r "2, N", grep -r "N, 2", grep -r "3, N", grep -r "N, 3" on bluemira/geometry/ and bluemira/codes/. They should return about 15 instances. My question is: why do some use (2, N)/(3, N) format, while others take the (N, 2)/(N, 3) format? Is there a rhyme or reason, and if not, can we have the same format everywhere? (I guess the papercut can be to turn this into a discussion if we don't come to an agreement? Or simply make the change and commit it if the conclusion is simple and straightforward.)
@OceanNuclear OceanNuclear added bug Something isn't working 📜 Papercut Papercut bug labels Feb 23, 2024
@OceanNuclear OceanNuclear added the discussion issue to be converted to a discussion label Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working discussion issue to be converted to a discussion 📜 Papercut Papercut bug
Projects
None yet
Development

No branches or pull requests

1 participant