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 req and dev readme with protobuf step #184

Closed
wants to merge 4 commits into from

Conversation

lalmei
Copy link
Contributor

@lalmei lalmei commented Mar 26, 2021

Still need your input on where to modify and change.

@lalmei lalmei added the documentation Improvements or additions to documentation label Mar 26, 2021
@coveralls
Copy link

coveralls commented Mar 26, 2021

Pull Request Test Coverage Report for Build 753121931

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.966%

Totals Coverage Status
Change from base Build 737102552: 0.0%
Covered Lines: 3190
Relevant Lines: 3704

💛 - Coveralls

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 30, 2021

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics Before After Change
Complexity 5.86 ⭐ 5.86 ⭐ 0.00
Method Length 138.00 😞 138.00 😞 0.00
Working memory 14.70 😞 14.70 😞 0.00
Quality 41.84% 😞 41.84% 😞 0.00%
Other metrics Before After Change
Lines 277 277 0
Changed files Quality Before Quality After Quality Change
docs/conf.py 40.49% 😞 40.49% 😞 0.00%
src/whylogs/_version.py 100.00% ⭐ 100.00% ⭐ 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation

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.

toml==0.10.2
tornado==6.1
smart-open==4.1.2
sphinx-autoapi>=1.4.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we shouldn't have sphinx devs in our dev dependencies. This is for documentation dependencies and they are separate

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i disagree, my understanding is that this was included as a full dependency for a developer working on this project. which what the team has been asking for. otherwise lets just remove this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but agree it shouldn't be part of the main requirements

Copy link
Contributor

@cswarth cswarth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lalmei lalmei closed this Apr 16, 2021
@lalmei lalmei deleted the requirements_and_dev_fixes branch May 1, 2021 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants