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 checker for common spelling mistakes #558

Merged
merged 6 commits into from
May 12, 2024
Merged
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
1 change: 1 addition & 0 deletions .codespellignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ges
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ venv/
ENV/
env.bak/
venv.bak/
node_modules/

# Created by https://www.toptal.com/developers/gitignore/api/macos
# Edit at https://www.toptal.com/developers/gitignore?templates=macos
Expand Down
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,28 @@ repos:
- id: trailing-whitespace
- id: check-toml
- id: check-json

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.4.3
hooks:
- id: ruff
args: ["--fix", "--exit-non-zero-on-fix"]
- id: ruff-format

- repo: https://github.com/pre-commit/mirrors-prettier
rev: "v4.0.0-alpha.8"
hooks:
- id: prettier
types_or: [yaml]
exclude: ".*/vcr_cassettes/.*\\.yaml"

- repo: https://github.com/codespell-project/codespell
rev: "v2.2.4"
hooks:
- id: "codespell"
exclude: ".codespellignore|tests/.*"
additional_dependencies: ["tomli"]

- repo: https://github.com/citation-file-format/cffconvert
rev: "054bda51dbe278b3e86f27c890e3f3ac877d616c"
hooks:
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
## [v0.5.2] 2023-04-21
* bug fixes:
* Fixing #230 by removing Benedict as the dict handler, thanks to @psarka!
* S3 credential endpoints are tried woth tokens and basic auth until all the DAACs accept the same auth
* S3 credential endpoints are tried with tokens and basic auth until all the DAACs accept the same auth

* Core dependencies:
* Removed Benedict as the default dict for JSON coming from CMR.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/emit-earthaccess.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"* For direct access this notebook should run in AWS\n",
"\n",
"\n",
"**IMPORTANT: This notebook should run out of AWS but is not recomended as streaming HDF5 data is slow out of region**\n"
"**IMPORTANT: This notebook should run out of AWS but is not recommended as streaming HDF5 data is slow out of region**\n"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/restricted-datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"* **environment**: If we have our EDL credentials as environment variables \n",
" * EARTHDATA_USERNAME\n",
" * EARTHDATA_PASSWORD\n",
"* **interactive**: We will be asked for our EDL credentials with optinal persistance to `.netrc`\n",
"* **interactive**: We will be asked for our EDL credentials with optional persistence to `.netrc`\n",
"\n",
"To persist our credentials to a `.netrc` file we have to do the following:\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion notebooks/DatasetSearch.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
"metadata": {},
"outputs": [],
"source": [
"# Nowe we get the collections' metadata\n",
"# Now we get the collections' metadata\n",
"collections = query.get(10)\n",
"# let's print only the first collection, uncomment the next line\n",
"# collections[0]"
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,7 @@ replace = 'version: "{new_version}"'
filename = "CITATION.cff"
search = 'date-released: "\d{{4}}-\d{{2}}-\d{{2}}"'
replace = 'date-released: "{now:%Y-%m-%d}"'

[tool.codespell]
skip = 'poetry.lock,*.ipynb,*.yml,*.yaml,./tests'
ignore-words = ".codespellignore"
Loading