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

PyOpenSci - REVIEW: enhance documentation and contributing.md #48

Closed
Robaina opened this issue Jan 25, 2023 · 0 comments · Fixed by #50
Closed

PyOpenSci - REVIEW: enhance documentation and contributing.md #48

Robaina opened this issue Jan 25, 2023 · 0 comments · Fixed by #50
Assignees
Labels
code review enhancement New feature or request

Comments

@Robaina
Copy link
Owner

Robaina commented Jan 25, 2023

Addressing:

Documentation

  • I recommend adding "Installation" & "Getting Started" sections in the documentation. The rationale is as follows: any part of the project may be a potential user's first contact. This includes the README file, the package description on Pypi (not applicable here) / a conda channel, and the documentation.

Agreed!

  • I would advise adding instructions on how to locally build the documentation in CONTRIBUTING.md in the section

Yes, that would be necessary. Will do.

3. Improving the documentation
  • The following mention is incorrect in the example notebook:

To follow this example, you don't need to download _E. coli's_ genome, since it has been already downloaded during Pynteny's installation.

The MG1655.gb file is stored in the tests folder, which is not included in the package. Therefore, when the package is installed using conda, it is not downloaded.

@Robaina Robaina added enhancement New feature or request code review labels Jan 25, 2023
@Robaina Robaina self-assigned this Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code review enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant