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 config, action (to only alert about new misspellings) + fix few typos #1541

Open
wants to merge 4 commits into
base: master
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[codespell]
skip = .git,*.pdf,*.svg,.codespellrc
check-hidden = true
# ignore-regex =
ignore-words-list = datas
22 changes: 22 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Codespell

on:
push:
branches: [master]
pull_request:
branches: [master]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Codespell
uses: codespell-project/actions-codespell@v2
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2103,7 +2103,7 @@ $ cat session.json
```

```bash
# Re-use the existing session — the API-Token header will be set:
# Reuse the existing session — the API-Token header will be set:
$ http --session=./session.json pie.dev/headers
```

Expand Down Expand Up @@ -2410,7 +2410,7 @@ HTTPie offers extensibility through a [plugin API](https://github.com/httpie/cli
and there are dozens of plugins available to try!
They add things like new authentication methods ([akamai/httpie-edgegrid](https://github.com/akamai/httpie-edgegrid)),
transport mechanisms ([httpie/httpie-unixsocket](https://github.com/httpie/httpie-unixsocket)),
message convertors ([banteg/httpie-image](https://github.com/banteg/httpie-image)), or simply
message converters ([banteg/httpie-image](https://github.com/banteg/httpie-image)), or simply
change how a response is formatted.

> Note: Plugins are usually made by our community members, and thus have no direct relationship with
Expand Down
2 changes: 1 addition & 1 deletion extras/profiling/benchmarks.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
$ python extras/profiling/benchmarks.py --fast

# For verify everything works as expected, pass --debug-single-value.
# It will only run everything once, so the resuls are not reliable. But
# It will only run everything once, so the results are not reliable. But
# very useful when iterating on a benchmark
$ python extras/profiling/benchmarks.py --debug-single-value

Expand Down