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

Make setuptools schema definitions up-to-date. #112

Merged
merged 4 commits into from Oct 11, 2023
Merged

Make setuptools schema definitions up-to-date. #112

merged 4 commits into from Oct 11, 2023

Conversation

abravalheri
Copy link
Owner

@abravalheri abravalheri merged commit 67faa9b into main Oct 11, 2023
29 checks passed
@abravalheri abravalheri deleted the fix-desc branch October 11, 2023 16:27
@henryiii henryiii mentioned this pull request Oct 11, 2023
@@ -1,14 +1,15 @@
{
"$schema": "http://json-schema.org/draft-07/schema",

"$id": "https://docs.python.org/3/install/",
"$id": "https://setuptools.pypa.io/en/latest/deprecated/distutils/configfile.html",
"title": "``tool.distutils`` table",
"$$description": [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this $$description? As far as I can tell, such as with https://json-schema.org/understanding-json-schema/reference/annotations, this field is supposed to be description, and schema store's validator doesn't like $$description.

Copy link
Collaborator

@henryiii henryiii Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh, this is a sphinx-jsonschema addition just to allow a list of strings instead of a string (at the expense of it not being standard)? https://pypi.org/project/sphinx-jsonschema/

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that is the reason.

It is very difficult to write long strings in vanilla JSON schema. $$description helps with that. The files can still be used by tools that don't support $$description with the drawback that they don't show the long explanations we have in the files.

We could generate the schemas by using YAML, or other solutions, but the problem is to take in more dependencies.

Since I designed the project to be compatible with build backends, I try to keep the dependencies at bay...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's always pre-processing, where you write a something.yml and convert it to the json schema, but do that in the repo. I did this with cibuildwheel, https://github.com/pypa/cibuildwheel/blob/main/bin/generate_schema.py (and nox job). That avoids a runtime dependency, only a development dependency.

But that's fine, I have to process this anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants