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

Drop most convenience methods from pyflatsurf #315

Open
saraedum opened this issue Sep 13, 2022 · 0 comments
Open

Drop most convenience methods from pyflatsurf #315

saraedum opened this issue Sep 13, 2022 · 0 comments

Comments

@saraedum
Copy link
Member

saraedum commented Sep 13, 2022

pyflatsurf adds some convenience methods to C++ objects, e.g., FlowDecomposition.cylinders() or FlatTriangulation.connections(). We should remove these methods in the current form because they will be very annoying to document (i.e., we cannot just point to the C++ documentation but have to write specific documentation for the Python interface here.)

Some of these methods should just exist on the C++ object, e.g., cylinders(), while others should be dropped, e.g., connections(); in the latter case we should make sure that it's easy to create the corresponding C++ object easily from Python.

Note that we don't need the added convenience that we initially planned here since everything is going to be wrapped in sage-flatsurf anyway. So ideally the C++ interface is is just an API that is not user facing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant