You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Addressing:
Agreed!
Yes, that would be necessary. Will do.
The text was updated successfully, but these errors were encountered: