8000 docs(fields): fix link to union modes by antoni-jamiolkowski · Pull Request #9431 · pydantic/pydantic · GitHub
[go: up one dir, main page]
Skip to content

docs(fields): fix link to union modes #9431

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
Merged
sydney-runkle merged 1 commit into from
May 15, 2024
Merged

docs(fields): fix link to union modes #9431

sydney-runkle merged 1 commit into from
May 15, 2024

Conversation

@antoni-jamiolkowski
Copy link
Contributor
@antoni-jamiolkowski antoni-jamiolkowski commented May 13, 2024 •
edited
Loading

Change Summary

The description of the union_mode parameter of the Field function is provided with a link to a nonexistent paragraph on the Standard Library Types page: https://docs.pydantic.dev/latest/api/standard_library_types/#union-mode

I believe that the correct link is: https://docs.pydantic.dev/latest/concepts/unions/#union-modes. It has been changed in this PR.

Related issue number

There is none.

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

@github-actions github-actions bot added documentation relnotes-fix Used for bugfixes. relnotes-change Used for changes to existing functionality which don't have a better categorization. labels May 13, 2024
@codspeed-hq
Copy link
codspeed-hq bot commented May 13, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #9431 will not alter performance

Comparing antoni-jamiolkowski:docs-change (8892d16) with main (1ea2116)

Summary

✅ 13 untouched benchmarks

@AlexWaygood AlexWaygood mentioned this pull request May 13, 2024
Merged
5 tasks
sydney-runkle
sydney-runkle approved these changes May 14, 2024
View reviewed changes
Copy link
Contributor
@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Looks great, thanks!

@sydney-runkle
Copy link
Contributor
sydney-runkle commented May 14, 2024

We're working on a fix for the typing extensions tests, and will merge this once that's fixed!

@sydney-runkle
Copy link
Contributor
sydney-runkle commented May 14, 2024

@antoni-jamiolkowski,

Could you please pull in the changes from main? That should allow tests to pass. Thanks!

@antoni-jamiolkowski
Copy link
Contributor Author
antoni-jamiolkowski commented May 14, 2024

@sydney-runkle,

Sure 🙂

@sydney-runkle sydney-runkle merged commit 0e3337f into pydantic:main May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@sydney-runkle sydney-runkle sydney-runkle approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation relnotes-change Used for changes to existing functionality which don't have a better categorization. relnotes-fix Used for bugfixes.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@antoni-jamiolkowski @sydney-runkle
0