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

Checking and organizing Volmdlr methods #255

Open
2 tasks done
sbendjebla opened this issue Dec 16, 2021 · 2 comments
Open
2 tasks done

Checking and organizing Volmdlr methods #255

sbendjebla opened this issue Dec 16, 2021 · 2 comments

Comments

@sbendjebla
Copy link
Contributor

  • I'm submitting a ...

    • bug report
    • feature request
  • What is the current behavior?

- Some volmdlr methods are written twice:
for example: LineSegment2D: polygon_points, here

- A lot of volmdlr methods are not documented, so others can't know what are their purposes, and sometimes, we develop a new method but it exists before!

- Methods names don't follow the same formalize
for example: discretization_points, polygon_points ?

- volmdlr methods are not organized in an alphabetical order, so, sometimes we are lost when we are checking if a method exists or not

  • If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem Avoid reference to other packages

  • What is the expected behavior?

  • What is the motivation / use case for changing the behavior?

  • Possible fixes

- I think, we should clean volmdlr methods, by using the same names for the same objectives, deleting duplicated methods, organizing the methods in an alphabetical order, and the most import add documentation

  • Please tell us about your environment:

    • branch: dev
    • commit:
    • python version:
@AxelRinghausen AxelRinghausen mentioned this issue Jan 6, 2022
8 tasks
@AxelRinghausen
Copy link
Contributor

The PR #369 addresses the following issue:

- Methods names don't follow the same formalize
for example: discretization_points, polygon_points ?

@AxelRinghausen
Copy link
Contributor

Methods polygonization should be called to_polygon or to_closed_polygon or to_closed_polygon_2d.

@masfaraud masfaraud added this to the Long term milestone Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants