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

Autogenerate possible values for enums in reference documentation #5137

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

charliermarsh
Copy link
Member

@charliermarsh charliermarsh commented Jul 16, 2024

Summary

For example:

Screenshot 2024-07-16 at 7 44 10 PM

Closes #5129.

@charliermarsh charliermarsh marked this pull request as ready for review July 16, 2024 23:28
@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jul 16, 2024

- `"first-index"`: Only use results from the first index that returns a match for a given package name.
- `"unsafe-first-match"`: Search for every package name across all indexes, exhausting the versions from the first index before moving on to the next.
- `"unsafe-best-match"`: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index.
Copy link
Member Author

Choose a reason for hiding this comment

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

We don't have to worry about the alignment here because we're not rendering to a terminal.

@charliermarsh charliermarsh force-pushed the charlie/api-reference-iv branch 4 times, most recently from bb44ec0 to d8e4da1 Compare July 16, 2024 23:43
@charliermarsh charliermarsh merged commit a191f84 into main Jul 17, 2024
51 checks passed
@charliermarsh charliermarsh deleted the charlie/api-reference-iv branch July 17, 2024 16:37
@charliermarsh
Copy link
Member Author

Going to merge because I want to include in a release, but happy to address any feedback post-merge.

Copy link
Member

@zanieb zanieb left a comment

Choose a reason for hiding this comment

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

Nice!

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

Successfully merging this pull request may close these issues.

Autogenerate "Possible values" in API reference
2 participants