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

wishes for mglw.geometry module #158

Open
Leterax opened this issue Jun 6, 2022 · 2 comments
Open

wishes for mglw.geometry module #158

Leterax opened this issue Jun 6, 2022 · 2 comments
Labels
good first issue Good for newcomers
Milestone

Comments

@Leterax
Copy link
Contributor

Leterax commented Jun 6, 2022

A few wishes I have for the geometry module:

  1. quad_2d should probably come with a normal attribute to set the direction of the plane
  2. quad_2d has a pos attribute, cube a center attribute. bbox and sphere have neither -> select one consistent name and add it to all objects
  3. Rename to either create_xxx or Xxx (create_sphere or Sphere) for a more pythonic interface
  4. Rename cube to cuboid/box because it's not a cube
  5. cube docs are wrong, they talk about width, height, and depth keywords but that info is in size

Feel free to add other feedback and I will create a PR when I have some free time.

@einarf
Copy link
Member

einarf commented Jun 6, 2022

We can't really rename things, but the other suggestions are reasonable. Instead of renaming there can be alias methods, but let's keep that within reason.

@einarf einarf added this to the Future milestone Nov 30, 2024
@einarf einarf added the good first issue Good for newcomers label Nov 30, 2024
@einarf
Copy link
Member

einarf commented Nov 30, 2024

Docs are fixed. I'll mark this as "good first issue" indicating that contributions are welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants