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

Support sphinx 4.3#62 #72

Merged
merged 10 commits into from Nov 10, 2021
Merged

Support sphinx 4.3#62 #72

merged 10 commits into from Nov 10, 2021

Conversation

mansenfranzen
Copy link
Owner

Addresses #62

@mansenfranzen mansenfranzen self-assigned this Nov 10, 2021
@mansenfranzen mansenfranzen temporarily deployed to ci November 10, 2021 23:32 Inactive
@mansenfranzen mansenfranzen temporarily deployed to ci November 10, 2021 23:32 Inactive
@mansenfranzen mansenfranzen added this to the v.1.5.1 milestone Nov 10, 2021
@sourcery-ai
Copy link

sourcery-ai bot commented Nov 10, 2021

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.65%.

Quality metrics Before After Change
Complexity 0.09 ⭐ 0.12 ⭐ 0.03 👎
Method Length 70.12 🙂 72.43 🙂 2.31 👎
Working memory 7.28 🙂 7.36 🙂 0.08 👎
Quality 78.43% 77.78% -0.65% 👎
Other metrics Before After Change
Lines 3938 4005 67
Changed files Quality Before Quality After Quality Change
sphinxcontrib/autodoc_pydantic/directives/directives.py 86.56% ⭐ 85.52% ⭐ -1.04% 👎
tests/test_autosummary.py 91.83% ⭐ 85.03% ⭐ -6.80% 👎
tests/test_configuration_config.py 78.88% ⭐ 77.92% ⭐ -0.96% 👎
tests/test_configuration_fields.py 78.25% ⭐ 77.93% ⭐ -0.32% 👎
tests/test_configuration_model.py 76.75% ⭐ 76.59% ⭐ -0.16% 👎
tests/test_configuration_settings.py 76.24% ⭐ 76.09% ⭐ -0.15% 👎
tests/test_configuration_validator.py 80.74% ⭐ 80.27% ⭐ -0.47% 👎
tests/test_directives.py 82.28% ⭐ 76.77% ⭐ -5.51% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
tests/test_directives.py test_example_model_with_field_and_validator 0 ⭐ 231 ⛔ 8 🙂 60.59% 🙂 Try splitting into smaller methods
tests/test_directives.py test_example_model_with_config 0 ⭐ 144 😞 7 🙂 70.18% 🙂 Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

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!

@mansenfranzen mansenfranzen linked an issue Nov 10, 2021 that may be closed by this pull request
@mansenfranzen mansenfranzen added the bug Something isn't working label Nov 10, 2021
@mansenfranzen mansenfranzen merged commit 755cfec into main Nov 10, 2021
@mansenfranzen mansenfranzen deleted the support_sphinx_4.3#62 branch November 10, 2021 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx 4.3 will include a breaking change for autodoc_pydantic
1 participant