Support sphinx 4.3#62 (Sourcery refactored) #73
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
| # account for changed signature in sphinx 4.3, see #62 | ||
| if sphinx.version_info >= (4, 3): | ||
| from sphinx.addnodes import desc_sig_space | ||
| return [Text(value), desc_sig_space()] | ||
| else: | ||
| if sphinx.version_info < (4, 3): | ||
| return f"{value} " | ||
| from sphinx.addnodes import desc_sig_space | ||
| return [Text(value), desc_sig_space()] |
There was a problem hiding this comment.
Function PydanticDirectiveBase.get_signature_prefix refactored with the following changes:
- Swap if/else branches (
swap-if-else-branches) - Remove unnecessary else after guard condition (
remove-unnecessary-else)
This removes the following comments ( why? ):
# account for changed signature in sphinx 4.3, see #62
| if sphinx.version_info >= (4, 3): | ||
| from sphinx.addnodes import desc_sig_space | ||
| return (desc_sig_space, | ||
| [desc_sig_punctuation, "="], | ||
| desc_sig_space, | ||
| value) | ||
| else: | ||
| if sphinx.version_info < (4, 3): | ||
| return [desc_annotation, f" = {value}"] | ||
| from sphinx.addnodes import desc_sig_space | ||
| return (desc_sig_space, | ||
| [desc_sig_punctuation, "="], | ||
| desc_sig_space, | ||
| value) |
There was a problem hiding this comment.
Function desc_annotation_default_value refactored with the following changes:
- Swap if/else branches (
swap-if-else-branches) - Remove unnecessary else after guard condition (
remove-unnecessary-else)
| if sphinx.version_info >= (4, 3): | ||
| from sphinx.addnodes import desc_sig_space | ||
| return ([desc_sig_punctuation, ":"], | ||
| desc_sig_space, | ||
| [pending_xref, type_str]) | ||
| else: | ||
| if sphinx.version_info < (4, 3): | ||
| return (": ", [pending_xref, type_str]) | ||
| from sphinx.addnodes import desc_sig_space | ||
| return ([desc_sig_punctuation, ":"], | ||
| desc_sig_space, | ||
| [pending_xref, type_str]) |
There was a problem hiding this comment.
Function desc_annotation_type_annotation refactored with the following changes:
- Swap if/else branches (
swap-if-else-branches) - Remove unnecessary else after guard condition (
remove-unnecessary-else)
Sourcery Code Quality Report✅ Merging this PR will increase code quality in the affected files by 0.46%.
Here are some functions in these files that still need a tune-up:
Legend and ExplanationThe emojis denote the absolute quality of the code:
The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request. Please see our documentation here for details on how these metrics are calculated. We are actively working on this report - lots more documentation and extra metrics to come! Help us improve this quality report! |
Pull Request #72 refactored by Sourcery.
If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.
NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.
See our documentation here.
Run Sourcery locally
Reduce the feedback loop during development by using the Sourcery editor plugin:
Review changes via command line
To manually merge these changes, make sure you're on the
support_sphinx_4.3#62branch, then run:Help us improve this pull request!