Skip to content

Commit

Permalink
⬆️ Upgrade typos and its configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
homersimpsons committed Dec 8, 2024
1 parent 0707c07 commit 9cc8303
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Check for typos
uses: crate-ci/typos@v1.27.3
uses: crate-ci/typos@v1.28.2
- name: Typos info
if: failure()
run: |
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_mesh/src/index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ where
#[derive(Debug, Error)]
pub enum MeshWindingInvertError {
/// This error occurs when you try to invert the winding for a mesh with [`PrimitiveTopology::PointList`](super::PrimitiveTopology::PointList).
#[error("Mesh winding invertation does not work for primitive topology `PointList`")]
#[error("Mesh winding inversion does not work for primitive topology `PointList`")]
WrongTopology,

/// This error occurs when you try to invert the winding for a mesh with
Expand Down
30 changes: 13 additions & 17 deletions typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,28 @@ extend-exclude = [
]
ignore-hidden = false

# Corrections take the form of a key/value pair. The key is the incorrect word
# and the value is the correct word. If the key and value are the same, the
# word is treated as always correct. If the value is an empty string, the word
# is treated as always incorrect.

# Match Whole Word - Case Sensitive
[default.extend-identifiers]
iy = "iy" # Variable name used in bevy_gizmos. Probably stands for "y-axis index", as it's being used in loops.
ser = "ser" # ron::ser - Serializer
SME = "SME" # Subject Matter Expert
Sur = "Sur" # macOS Big Sur - South
Masia = "Masia" # The surname of one of the authors of SMAA
Ba = "Ba" # Bitangent for Anisotropy
ba = "ba" # Part of an accessor in WGSL - color.ba

# Match Inside a Word - Case Insensitive
[default.extend-words]
LOD = "LOD" # Level of detail
TOI = "TOI" # Time of impact

[default]
locale = "en-us"
# Ignored typos regexes
extend-ignore-identifiers-re = [
"NDK", # NDK - Native Development Kit
"Ba", # Bitangent for Anisotropy
"ba", # Part of an accessor in WGSL - color.ba
"ser", # ron::ser - Serializer
"SME", # Subject Matter Expert
"Sur", # macOS Big Sur - South
"NDK", # NDK - Native Development Kit
"PNG", # PNG - Portable Network Graphics file format
"Masia", # The surname of one of the authors of SMAA
"metalness", # Technical term preferred over metallicity in rendering
"inventario", # Inventory in Portuguese
"PNG", # PNG - Portable Network Graphics file format
"unparented", # Technically more correct than parentless
"hemicircles", # More correct than semicircle in the context of geometries
"[Rr]eparametrize", # Mathematical term, prefer over suggested reparameterize
# Used in bevy_mikktspace
"iFO",
"vOt",
Expand Down

0 comments on commit 9cc8303

Please sign in to comment.