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] clarify keyword "keywords" requirements #3396

Closed
1 task done
ynikitenko opened this issue Jun 20, 2022 · 5 comments · Fixed by #3397
Closed
1 task done

[Docs] clarify keyword "keywords" requirements #3396

ynikitenko opened this issue Jun 20, 2022 · 5 comments · Fixed by #3397
Labels
documentation Needs Triage Issues that need to be evaluated for severity and status.

Comments

@ynikitenko
Copy link

Summary

At https://setuptools.pypa.io/en/latest/references/keywords.html there is a keyword keywords:

A list of strings or a comma-separated string providing descriptive meta-data. See: PEP 0314.

However, in PEP 314 there is no requirement for the string to be comma-separated (in fact, the example there is without commas, and I earlier used strings without commas):

A list of additional keywords to be used to assist searching for the package in a larger catalog.

Please fix your documentation or refer to a proper source.

OS / Environment

No response

Additional Information

This makes documentation non self-contradictory: correct (in the case of fix) or understandable by users (in the case of a proper link).

Code of Conduct

  • I agree to follow the PSF Code of Conduct
@ynikitenko ynikitenko added documentation Needs Triage Issues that need to be evaluated for severity and status. labels Jun 20, 2022
@ynikitenko
Copy link
Author

I found that there were recent documentation changes, but this doesn't seem to be addressed by them. #3307

@ynikitenko
Copy link
Author

One more note: I really use a string without commas in my setup.py, and they seem to be automatically inserted on PyPI (https://pypi.org/project/lena/). So probably commas are still not required in the setup file.

@abravalheri
Copy link
Contributor

abravalheri commented Jun 20, 2022

Hi @ynikitenko thank you very much for the PR.

The core metadata standard is a live standard, which means that its most recent version can be found in:
https://packaging.python.org/en/latest/specifications/core-metadata/#keywords.

That pages does mention commas. The request for changing the ref is very legit 😄

@ynikitenko
Copy link
Author

Hi @abravalheri , thanks for the quick update and for the link! Just out of curiosity, what happens if I don't use commas? As I wrote, PyPI separated all my keywords by commas (if I ever intended it to be one sentence :) .

@abravalheri
Copy link
Contributor

I don't know if setuptools or PyPI has some fallback logic to handle that... It might be the case. But it is better to stick to the standard, since the fallback logic may be removed in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Needs Triage Issues that need to be evaluated for severity and status.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants