python-poetry / python-poetry/poetry
"poetry build" should detect that the (pyproject.toml) description is not empty
Open
Nobody has claimed this yet.
kind/feature
status/triage
- Dominant language
- Python
- Stars
- 34.3k
- Forks
- 2.5k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 30
Description
- [X ] I have searched the issues of this repo and believe that this is not a duplicate.
- [ X] I have searched the documentation and believe that my question is not covered.
Feature Request
In pyproject.toml there is a description field in the [tool.poetry] section. This is required.
It would be a good sanity check to flag to the user (either after a poetry build or before a poetry publish) when the field is empty.
Contributor guide
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 by tracing the validation performed by poetry build and poetry publish for the [tool.poetry] section in pyproject.toml. Determine where an empty description should be reported, then add coverage showing that an empty field is flagged during the selected command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100