Skip to content

codespell: Avoid project-level ignore words if possible #4691

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.

Sign up for GitHub

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

Merged
seisman merged 1 commit into from
Jun 24, 2026
+5 −5
Merged

codespell: Avoid project-level ignore words if possible #4691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion doc/techref/justification_codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ fig = pygmt.Figure()
fig.basemap(projection="X10c/2c", region=[-size, size, -size, size], frame=0)

fig.colorbar(
cmap="SCM/buda",
cmap="SCM/hawaii",

@seisman seisman Jun 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Any CPT can be used in this file. Choose SCM/hawaii so that codespell doesn't report buda.

frame=0,
position="MC",
length=10,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/datatypes/header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ def data_attrs(self) -> Mapping[str, Any]:
GridFormat.NS,
GridFormat.NI,
GridFormat.NF,
GridFormat.ND,
GridFormat.ND, # codespell:ignore

@seisman seisman Jun 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The codespell syntax for inline igore (xref: https://github.com/codespell-project/codespell#inline-ignore).

}: # Set attributes specific to CF-1.7 conventions
attrs["Conventions"] = "CF-1.7"
attrs["title"] = self.title.decode()
Expand Down
2 changes: 1 addition & 1 deletion pygmt/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class GridFormat(IntEnum):
NS = 16 #: GMT netCDF format (16-bit integer)
NI = 17 #: GMT netCDF format (32-bit integer)
NF = 18 #: GMT netCDF format (32-bit float)
ND = 19 #: GMT netCDF format (64-bit float)
ND = 19 #: GMT netCDF format (64-bit float) # codespell:ignore

@seisman seisman Jun 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The codespell syntax for inline igore (xref: https://github.com/codespell-project/codespell#inline-ignore).

SD = 20 #: Golden Software Surfer format 7 (64-bit float, read-only)
AF = 21 #: Atlantic Geoscience Center format AGC (32-bit float)
GD = 22 #: Import through GDAL
Expand Down
2 changes: 1 addition & 1 deletion pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
or (m)\ **e**\ (ters), **f**\ (eet), **k**\ (ilometers),
**M**\ (iles), or **n**\ (autical miles) [Default is (m)\ **e**\ (ters)].
- For projected data (**X**\|\ **Y**\|\ **D**), the unit may be
**i**\ (nches), **c**\ (entimeters), or **p**\ (oints).
**i** (inches), **c** (centimeters), or **p** (points).

@seisman seisman Jun 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We will likely get more false positives if we keep using the syntax like **i**\ (nches). I think we should try our best to avoid using it in the future.

Append modifier **+a** to specify that *all* the criteria must be
met [default imposes breaks if any one criterion is met].
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ local_scheme = "node-and-date"
fallback_version = "999.999.999+unknown"

[tool.codespell]
ignore-words-list = "astroid,buda,oints,reenable,te,tripel,trough,ND"
ignore-words-list = "astroid,te,tripel,trough"

@seisman seisman Jun 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We can't use the inline ignore syntax (# codespell:ignore) for these words because they are used in the documentation. Otherwise, the ignore comments would appear in the code examples shown in the docs.


[tool.coverage.run]
omit = ["*/tests/*", "*pygmt/__init__.py"]
Expand Down
Loading