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 codespell support (config, workflow to detect/not fix) and make it fix few typos #492

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ repos:
hooks:
- id: flake8

# Lint: Typos
- repo: https://github.com/codespell-project/codespell
# Configuration for codespell is in pyproject.toml
rev: v2.2.6
hooks:
- id: codespell
additional_dependencies:
- tomli

# pre-commit.ci config reference: https://pre-commit.ci/#configuration
ci:
autoupdate_schedule: monthly
2 changes: 1 addition & 1 deletion docs/source/server-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ One of:
Whether to report activity from the proxy to Jupyter Server. If _True_, Jupyter Server
will be notified of new activity. This is primarily used by JupyterHub for idle detection and culling.

Useful if you want to have a seperate way of determining activity through a
Useful if you want to have a separate way of determining activity through a
proxied application.

Defaults to _True_.
Expand Down
2 changes: 1 addition & 1 deletion jupyter_server_proxy/handlers.py
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ def rewrite_pe(rewritable_response: RewritableResponse):
},
)

# Now we can cleanly apply the partially evaulated function to a copy of
# Now we can cleanly apply the partially evaluated function to a copy of
# the rewritten response.
rewritten_response = rewritten_response._apply_to_copy(rewrite_pe)

Expand Down
7 changes: 7 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -223,3 +223,10 @@ concurrency = [

[tool.coverage.html]
show_contexts = true

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git*,*.svg,*.lock'
check-hidden = true
ignore-regex = '\bTE\b'
Copy link
Member

Choose a reason for hiding this comment

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

Can you add a comment for why this is needed (presumably you've found some intentional use of TE?)

# ignore-words-list = ''