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

Add spelling and docstring enforcement #1147

Merged
merged 11 commits into from
Dec 27, 2022
Merged

Conversation

blink1073
Copy link
Contributor

@blink1073 blink1073 commented Dec 22, 2022

Based on reading Boring Python: code quality, adding two more checkers: sphinxcontrib-spelling, and interrogate for docstring enforcement, and adding a few more builtin pre-commit checkers.

I'm putting validate-pyproject and check-wheel-contents into the check-python script in jupyter-releaser to centralize those. I tried pyroma but it assumes setuptools is used.

Most of the changes are adding docstrings to modules, classes, and methods.

@codecov
Copy link

codecov bot commented Dec 22, 2022

Codecov Report

Base: 80.07% // Head: 80.01% // Decreases project coverage by -0.06% ⚠️

Coverage data is based on head (0a909a7) compared to base (66dfa0e).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1147      +/-   ##
==========================================
- Coverage   80.07%   80.01%   -0.07%     
==========================================
  Files          68       68              
  Lines        8062     8062              
  Branches     1600     1600              
==========================================
- Hits         6456     6451       -5     
- Misses       1183     1186       +3     
- Partials      423      425       +2     
Impacted Files Coverage Δ
jupyter_server/_tz.py 100.00% <ø> (ø)
jupyter_server/auth/__main__.py 0.00% <ø> (ø)
jupyter_server/auth/identity.py 86.28% <ø> (ø)
jupyter_server/auth/login.py 81.69% <ø> (ø)
jupyter_server/auth/logout.py 77.77% <ø> (ø)
jupyter_server/base/handlers.py 78.82% <ø> (ø)
jupyter_server/base/websocket.py 68.11% <ø> (ø)
jupyter_server/extension/application.py 73.36% <ø> (ø)
jupyter_server/extension/config.py 72.22% <ø> (ø)
jupyter_server/extension/handler.py 67.18% <ø> (ø)
... and 36 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@blink1073 blink1073 merged commit 898d180 into jupyter-server:main Dec 27, 2022
@blink1073 blink1073 deleted the more-ci branch December 27, 2022 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant