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

PyPi site documentation: q's / suggestions #121

Open
afitzgerrell opened this issue Jan 15, 2025 · 1 comment
Open

PyPi site documentation: q's / suggestions #121

afitzgerrell opened this issue Jan 15, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@afitzgerrell
Copy link
Contributor

  1. There are two Requirements sections...one near the top of the page, but another toward the bottom of the page after the Troubleshooting and Contributing sections. The second Requirements section lists Python and Poetry and proceeds to detail how to install Poetry, followed by a Releasing section. Are these relevant or are they to be removed?

  2. At the Installation section, I suggest removing "That's it! Now we're ready to run MetGenC and see what it can do:" AND the code box showing the usage of metgenc since Usage is a section unto itself further down on the page.

  3. In the Usage section, the 2nd code box (showing metgenc --help response) is out of date as it's not showing the validation option and explanation. As time allows, can this be updated?

@afitzgerrell afitzgerrell added the documentation Improvements or additions to documentation label Jan 15, 2025
@afitzgerrell
Copy link
Contributor Author

Now that I learned that the README.md and pypi are actually supposed to jive, i've taken it upon myself to make these edits and relinquish kevin from the burden of this fluffy (but important!) documentation stuff.

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

No branches or pull requests

3 participants