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

Minor issues in the documentation #3

Closed
expectopatronum opened this issue Jul 1, 2021 · 2 comments
Closed

Minor issues in the documentation #3

expectopatronum opened this issue Jul 1, 2021 · 2 comments

Comments

@expectopatronum
Copy link

Hi again,
while reviewing I noticed a few minor things in the README/documentation:

  • I don't see a statement of need in the documentation. There is a detailed statement of need in the paper but the review check list also asks for a statement of need in the documentation.
  • The info can be found from setup.py but for me as a user it would be helpful to see at one glance which Python version is required (e.g. in the README in section "Installing")
  • Community Guidelines: There is a section regarding contributing, but it does not mention how to "Report issues or problems with the software" or "Seek support", although I would expect it through the same channels (mail to the main author, github issue).

Best regards
Verena

@fzalkow
Copy link
Collaborator

fzalkow commented Jul 1, 2021

Many thanks for these points. I addressed them in the commit 1ad2124.

Best,

Frank

@expectopatronum
Copy link
Author

Perfect, thanks!

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

2 participants