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 incomplete #5

Open
florianjehn opened this issue Feb 12, 2024 · 0 comments
Open

Documentation incomplete #5

florianjehn opened this issue Feb 12, 2024 · 0 comments
Assignees
@jamesmulhall
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@florianjehn
Copy link

florianjehn commented Feb 12, 2024 •
edited
Loading

  • Docstrings do not follow our guidelines (https://github.com/allfed/ALLFED-Repository-Template)
  • Incomplete readme with dead links
  • Code is split between /src and notebooks. Notebooks should not be used to contain large chunks of code, as this makes things much harder to maintain.
@florianjehn florianjehn added bug Something isn't working documentation Improvements or additions to documentation labels Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jamesmulhall jamesmulhall

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@florianjehn @jamesmulhall