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

Add documentation #24

Open
goldrafa opened this issue Aug 2, 2024 · 0 comments
Open

Add documentation #24

goldrafa opened this issue Aug 2, 2024 · 0 comments

Comments

@goldrafa
Copy link

goldrafa commented Aug 2, 2024

Nice project! However, the documentation seems quite incomplete. Apart from a general description of the project and the pip install procedure, there is no further documentation on usage and code implementation. Even though there is nbdev-markup throughout the code, the Jupyter notebooks found in the file structure include only the testing of the individual classes and functions. Last but not least, there are no comments regarding the use of pytest for the feems package and nbdev_test on the other two packages contained in this project.

Happy for any clarification, if I'm missing the point here.

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

No branches or pull requests

1 participant