Skip to content

Fix inaccurate docstring example in _BaseMultiHostUrl.query_params() #11611

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
merged 2 commits into from
Mar 25, 2025
Merged

Fix inaccurate docstring example in _BaseMultiHostUrl.query_params() #11611

merged 2 commits into from
Mar 25, 2025

Conversation

Jeukoh
Copy link
Contributor

@Jeukoh Jeukoh commented Mar 24, 2025 •
edited by pydantic-hooky bot
Loading

Change Summary

The previous docstring included a mismatched query example, which could cause confusion.
The updated docstring uses a corresponding return value to clearly demonstrate expected behavior.

Related issue number

N/A

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

Selected Reviewer: @sydney-runkle

@Jeukoh Jeukoh force-pushed the docs/query-params-in-MultiHostUrl branch from 57b64f7 to b91a0e9 Compare March 24, 2025 11:39
@Jeukoh
Copy link
Contributor Author

Jeukoh commented Mar 24, 2025

please review

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Mar 24, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #11611 will not alter performance

Comparing Jeukoh:docs/query-params-in-MultiHostUrl (ed24646) with main (8e98bc0)

Summary

✅ 46 untouched benchmarks

@github-actions GitHub Actions
Copy link
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@Viicos Viicos changed the title Fix inaccurate docstring example in _BaseMultiHostUrl.query_params Fix inaccurate docstring example in _BaseMultiHostUrl.query_params() Mar 25, 2025
Viicos
Viicos approved these changes Mar 25, 2025
View reviewed changes
Copy link
Member

@Viicos Viicos left a comment

Choose a reason for hiding this comment

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

Thanks for the fix

Viicos
Viicos reviewed Mar 25, 2025
View reviewed changes
@Viicos Viicos enabled auto-merge (squash) March 25, 2025 13:38
@Viicos Viicos added relnotes-ignore Omit this PR from the release notes. and removed ready for review labels Mar 25, 2025
@Viicos Viicos merged commit 6433ea7 into pydantic:main Mar 25, 2025
59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Viicos Viicos Viicos approved these changes

Assignees
No one assigned
Labels
documentation relnotes-ignore Omit this PR from the release notes.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Jeukoh @Viicos