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

fix: Fix process of build documentation #653

Merged
merged 5 commits into from
Jun 20, 2022
Merged

Conversation

Czaki
Copy link
Collaborator

@Czaki Czaki commented Jun 20, 2022

No description provided.

@deprecated-napari-hub-preview-bot
Copy link

deprecated-napari-hub-preview-bot bot commented Jun 20, 2022

Preview page for your plugin is ready here:
https://preview.napari-hub.org/4DNucleome/PartSeg/653
Updated: 2022-06-20T09:31:51.676730

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 20, 2022

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics Before After Change
Complexity 4.59 ⭐ 4.59 ⭐ 0.00
Method Length 54.83 ⭐ 54.83 ⭐ 0.00
Working memory 9.51 🙂 9.51 🙂 0.00
Quality 64.64% 🙂 64.64% 🙂 0.00%
Other metrics Before After Change
Lines 61 61 0
Changed files Quality Before Quality After Quality Change
package/PartSegCore/sphinx/auto_parameters.py 64.64% 🙂 64.64% 🙂 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation
package/PartSegCore/sphinx/auto_parameters.py algorithm_parameters_doc 10 🙂 95 🙂 14 😞 53.37% 🙂 Extract out complex expressions
package/PartSegCore/sphinx/auto_parameters.py RegisterDocumenter.add_content 4 ⭐ 171 😞 10 😞 56.86% 🙂 Try splitting into smaller methods. Extract out complex expressions

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!

@codecov
Copy link

codecov bot commented Jun 20, 2022

Codecov Report

Merging #653 (832ba9b) into develop (33ac6a0) will not change coverage.
The diff coverage is 0.00%.

@@           Coverage Diff            @@
##           develop     #653   +/-   ##
========================================
  Coverage    82.91%   82.91%           
========================================
  Files          143      143           
  Lines        19129    19129           
========================================
  Hits         15861    15861           
  Misses        3268     3268           
Impacted Files Coverage Δ
package/PartSegCore/sphinx/auto_parameters.py 0.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 33ac6a0...832ba9b. Read the comment docs.

@Czaki Czaki merged commit 2f14925 into develop Jun 20, 2022
@Czaki Czaki deleted the fix_documentation_build branch June 20, 2022 10:38
@Czaki Czaki added this to the v0.14.3 milestone Jun 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant