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.

Sign up for GitHub

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

Jump to bottom

Documentation #11

Open
ns-rse opened this issue Nov 25, 2024 · 0 comments
Open

Documentation #11

ns-rse opened this issue Nov 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ns-rse
Copy link

ns-rse commented Nov 25, 2024

Documentation of the API via numpydoc strings will make it easy for users and future developers to understand how to work with and develop the package.

Writing documentation to accompany the package on its own and also under pgfinder will also be useful in explaining the functionality and algorithms and will be useful when writing up methods in the future.
@ns-rse ns-rse added the documentation Improvements or additions to documentation label Nov 25, 2024
This was referenced Nov 25, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ns-rse