Skip to content
This repository was archived by the owner on Apr 22, 2023. It is now read-only.

Conversation

@Anselmoo
Copy link
Contributor

@Anselmoo Anselmoo commented Feb 8, 2021

Updating the docs and setup the webpage, and setup.py

@Anselmoo Anselmoo added the enhancement New feature or request label Feb 8, 2021
@sourcery-ai
Copy link

sourcery-ai bot commented Feb 8, 2021

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 1.72 ⭐ 1.72 ⭐ 0.00
Method Length 38.00 ⭐ 38.71 ⭐ 0.71 👎
Working memory 10.96 😞 10.96 😞 0.00
Quality 75.45% 75.34% -0.11% 👎
Other metrics Before After Change
Lines 317 325 8
Changed files Quality Before Quality After Quality Change
setup.py 54.97% 🙂 54.97% 🙂 0.00%
docs/generate_docs.py 58.66% 🙂 57.19% 🙂 -1.47% 👎
mkdocstrings_sourcelink/auto_generator.py 78.02% ⭐ 78.02% ⭐ 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation
mkdocstrings_sourcelink/auto_generator.py MkDocGenerator.__init__ 0 ⭐ 65 🙂 14 😞 67.51% 🙂 Extract out complex expressions
mkdocstrings_sourcelink/auto_generator.py MkDocGenerator.generate_static 6 ⭐ 50 ⭐ 10 😞 70.55% 🙂 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!

Let us know what you think of it by mentioning @sourcery-ai in a comment.

@Anselmoo Anselmoo merged commit 9e0c9b8 into AI2Business:main Feb 8, 2021
@Anselmoo Anselmoo deleted the Fixed-docs branch February 8, 2021 19:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant