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

Document Poetry dependency schema #6600

Open
1 task done
zanieb opened this issue Sep 22, 2022 · 3 comments
Open
1 task done

Document Poetry dependency schema #6600

zanieb opened this issue Sep 22, 2022 · 3 comments
Labels
area/docs Documentation issues/improvements status/triage This issue needs to be triaged

Comments

@zanieb
Copy link
Contributor

zanieb commented Sep 22, 2022

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

Issue

Hi! I can't seem to find documentation on the all the available options for a Poetry dependency. It'd be great to have a schema somewhere in the documentation.

For example, platform (added in 20c87bc) is not included in the dependency specification page and is not PEP-0508 compliant so users and consumers (e.g. pdm-project/pdm#1384) do not know what fields can be used.

https://python-poetry.org/docs/dependency-specification seems like the relevant page to add this information

Related to #738, #1207

@zanieb zanieb added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Sep 22, 2022
@dimbleby
Copy link
Contributor

https://github.com/python-poetry/poetry-core/blob/main/src/poetry/core/json/schemas/poetry-schema.json

If you can find a sensible place to point at that from the docs I expect an MR would be welcome

@zanieb
Copy link
Contributor Author

zanieb commented Sep 22, 2022

Thanks for the link! That's helpful. I'm a bit hesitant to just link out to main and I don't see a great way to template a tag when the documentation is generated. Seems like that'd be important for maintenance over time.

@dimbleby
Copy link
Contributor

I agree. Maybe put something together anyway and let the maintainers advise what to do about it.

The schema would so clearly be targeted at developers only: perhaps it's not crazy to tuck this away in a footnote and say something like "there's a schema in the poetry-core repository if you really want to get into this, you'll have to figure out for yourself what the right tag is".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues/improvements status/triage This issue needs to be triaged
Projects
None yet
Development

No branches or pull requests

2 participants