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

Better API documentation #55

Open
simbilod opened this issue May 24, 2023 · 4 comments
Open

Better API documentation #55

simbilod opened this issue May 24, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@simbilod
Copy link
Contributor

The examples are great, but it would be helpful to have better docstrings for functions such as compute_modes

@EliDoris

@simbilod
Copy link
Contributor Author

Example of great API docs: https://mpb.readthedocs.io/en/latest/Python_User_Interface/

@HelgeGehring
Copy link
Owner

Sounds great!

@HelgeGehring HelgeGehring added the documentation Improvements or additions to documentation label May 24, 2023
@EliDoris
Copy link

I should note that code functionality and the examples were much easier to digest after I read through the documentation for skfem and shapely. It could be helpful to mention on the documentation homepage that this package leverages those and link to their docs

@HelgeGehring
Copy link
Owner

I'll add it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants