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

Docs Limit Keywords To 5 #4183

Closed
1 task done
HassanAbouelela opened this issue Jun 15, 2021 · 3 comments · Fixed by #4635
Closed
1 task done

Docs Limit Keywords To 5 #4183

HassanAbouelela opened this issue Jun 15, 2021 · 3 comments · Fixed by #4635
Labels
area/docs Documentation issues/improvements

Comments

@HassanAbouelela
Copy link

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

The pyproject docs make the following claim about keywords:

A list of keywords (max: 5) that the package is related to. Optional

- https://python-poetry.org/docs/pyproject/#keywords

From my testing, this limit is not actually enforced in any way, and I'm not quite sure why it exists. I've asked on the discord server here, and didn't get a conclusive answer.

I deployed this package with 7 keywords from this pyproject.

At no point did anything complain, and all 7 tags show up fine on the pypi page. (For reference, the linked package is converting an already existing package from using setuptools to poetry. The main package has the same 7 tags with no problem.)

I traced this change back to a commit (e907f40) that added a bunch of documentation, and I can't see a clear reason behind the limit.

@HassanAbouelela HassanAbouelela added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Jun 15, 2021
@Mariatta
Copy link
Contributor

Looking the code, indeed it seems that there is no limit enforced by poetry. PEP 314 also did not constraint the keywords to any specific limit. https://www.python.org/dev/peps/pep-0314/#keywords-optional
I would suggest removing the limit from the doc.

Mariatta added a commit to Mariatta/poetry that referenced this issue Oct 13, 2021
The code does not enforce any limit.
Additionally, there is no limit set in PEP 314
( https://www.python.org/dev/peps/pep-0314/#keywords-optional )

Closes python-poetry#4183
@Mariatta
Copy link
Contributor

The readme.md also mentions that keywords are up to 5. I made the PR to remove it. #4635

Copy link

github-actions bot commented Mar 2, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants