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.

Sign up for GitHub

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

Jump to bottom

Dump schema descriptions #281

Merged
merged 9 commits into from
Nov 27, 2024
Merged

Dump schema descriptions #281

merged 9 commits into from
Nov 27, 2024

Conversation

jaimergp
Copy link
Contributor

@jaimergp jaimergp commented Nov 24, 2024 •
edited
Loading

Description

We were not dumping this in the JSON document because pydantic doesn't really support the Sphinx syntax. Use Field directly. The diff is big but the changes can be seen in the .json file instead of the .py, for simplicity.

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Nov 24, 2024
@jaimergp jaimergp marked this pull request as ready for review November 25, 2024 11:52
@jaimergp jaimergp requested a review from a team as a code owner November 25, 2024 11:52
marcoesters
marcoesters reviewed Nov 26, 2024
View reviewed changes
Copy link
Contributor

@marcoesters marcoesters left a comment

Choose a reason for hiding this comment

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

The descriptions contain a lot of line feed characters that don't seem to be necessary. Also, do we want to use sphinx-style links?

@jaimergp
Copy link
Contributor Author

jaimergp commented Nov 27, 2024 •
edited
Loading

Also, do we want to use sphinx-style links?

I'd rather not, but autodoc_pydantic expects RST syntax in the descriptions, I'm afraid :( Unfortunately, RST is not rendered properly in IDE autocompletion (at least in VS Code). Let me see if there's a way to have autodoc_pydantic take MD.

@jaimergp
Copy link
Contributor Author

Well, terribly hacky but it works! Let me know what you think.

@jaimergp jaimergp merged commit 55f9e18 into conda:main Nov 27, 2024
16 checks passed
@jaimergp jaimergp deleted the use-fields branch November 27, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcoesters marcoesters marcoesters approved these changes

Assignees
No one assigned
Labels
cla-signed [bot] added once the contributor has signed the CLA
Projects
🔎 Review
Status: 🏁 Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jaimergp @marcoesters @conda-bot