fix: Correct docstring typos in client template #1347
Merged
+22
−22
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
- Fix with_timeout docstring to say "timeout configuration" instead of "in seconds" since the method accepts an httpx.Timeout object, not a numeric value - Fix set_async_httpx_client docstring to include missing verb "set" These changes improve the accuracy of the generated client documentation.
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 3, 2025
> [!IMPORTANT] > Merging this pull request will create this release ## Fixes - Remove non-existent CHANGELOG.md references from UV and Poetry templates (#1344) - Initialize optional lists as UNSET, not [] (#1346) - Correct docstring typos in client template (#1347) - Replace bare except blocks with specific exception types (#1348) ### Update `uv_build` to 0.9 #1352 by @johnthagen `uv` has been in the `0.9.x` release cycle for a while, so update templates to use the corresponding `uv_build` range. Co-authored-by: knope-bot[bot] <152252888+knope-bot[bot]@users.noreply.github.com>
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.
Summary
with_timeoutdocstring to say "timeout configuration" instead of "in seconds" since the method accepts anhttpx.Timeoutobject, not a numeric valueset_async_httpx_clientdocstring to include missing verb "set"Changes
openapi_python_client/templates/client.py.jinja:93to correct thewith_timeoutdescriptionopenapi_python_client/templates/client.py.jinja:136to fix the grammatical error inset_async_httpx_clientTest plan
pdm regenThese changes improve the accuracy of the generated client documentation and fix grammatical errors.