Skip to content

Typos visible in the code, and the documentation generated from it #424

Description

@eero-t

Running spell checker on the code, shows quite a few spelling issues:

$ codespell --ignore-words-list pEvents  --skip third_party | cut -d: -f3- | sort | uniq -c | sort -nr
     20  Freqency ==> Frequency
     20  configurating ==> configuring
      6  unkown ==> unknown
      4  Heterogenous ==> Heterogeneous
      4  enqueing ==> enqueuing
      4  arugment ==> argument
      3  discription ==> description
      3  compatability ==> compatibility
      2  typicall ==> typically, typical
      2  temporaly ==> temporary, temporarily, temporally
      2  Supportted ==> Supported
      2  pysical ==> physical
      2  programing ==> programming
      2  non-existant ==> non-existent
      2  Minumum ==> Minimum
      2  iamge ==> image
      2  guarentee ==> guarantee
      2  gaurantee ==> guarantee
      2  garanteed ==> guaranteed
      2  extention ==> extension
      2  explictly ==> explicitly
      2  enusre ==> ensure
      2  contols ==> controls
      2  arrary ==> array
      2  Aligment ==> Alignment
      1  substitues ==> substitutes
      1  retreive ==> retrieve
      1  retreived ==> retrieved
      1  reenabled ==> re-enabled
      1  Pluse ==> Pulse, Plus
      1  overide ==> override
      1  Implemeneted ==> Implemented
      1  genrate ==> generate
      1  exeuction ==> execution
      1  defintion ==> definition
      1  decending ==> descending
      1  ablity ==> ability

After these are fixed, I would suggest adding CI test that does similar codespell run.

PS. I did above in Fedora, but codespell is available on all major distros, e.g: https://packages.ubuntu.com/source/noble/codespell

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions