python-poetry / python-poetry/poetry-plugin-bundle
Add documentation for this bundle
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 151
- Forks
- 30
- Avg merge
- 48m
- Merged PRs (30d)
- 5
Description
The README doesn't mention most of the possible command line options. Is there a way to generate documentation on e.g. which options this extension supports? For people, e.g. using this in docker we may not have access to actually run it with --help so it would be nice if the readme gave some kind of overview of usage.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README and inspect the bundle command's --help output or command entry point to identify the supported options. Document the available options and a usage overview in the README, including information useful when the plugin is used from Docker. Done means the README covers the command-line options without requiring the tool to be run interactively.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100