flatsurf / sage-flatsurf

Flat surfaces in Sage
https://flatsurf.github.io/sage-flatsurf/
GNU General Public License v2.0
10 stars 10 forks source link

Improve documentation for cppyy objects #164

Open saraedum opened 2 years ago

saraedum commented 2 years ago

Currently, cppyy objects such as a FlowDecomposition are not properly documented. We probably do not want to expose them directly anyway but wrap them in sage-flatsurf and then write proper docstrings.

Otherwise, it would be great if we could somehow get docstrings for these from the C++ documentation and maybe also rename the methods so the are more_pythonic().

At the very least, we should try to point people to the C++ header file.