Convert schema comments to descriptions #709
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This will render the schema in the reference docs better, as I didn't bother implementing any handling for `Extra: object`.
This way they'll be rendered in the docs.
Collaborator
Author
|
This PR was AI assisted. |
jcristau
approved these changes
Jun 25, 2025
Contributor
jcristau
left a comment
jcristau
left a comment
There was a problem hiding this comment.
More of a rubberstamp than anything else, but this looks plausible.
Comment on lines
+39
to
+43
| description=dedent( | ||
| """ | ||
| Name of the docker image. | ||
| """ | ||
| ).lstrip(), |
Contributor
There was a problem hiding this comment.
That's a pretty verbose way of saying description="Name of the docker image."
Collaborator
Author
There was a problem hiding this comment.
Yeah, initially I had it like that and I thought it looked a bit weird with half of them using dedent and half of them not. And I also figured this way we can improve the description with minimal changes?
I'm not tied to this though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This ensures they show up in the docs.