Request for Changes-61: Use codespell to fix common misspellings in source code

From OTBWiki
Jump to: navigation, search

Status

  • Author: Manuel Grizonnet
  • Additional Contributors (if different than authors):
  • Submitted on 15.09.2016
  • Proposed target release: 5.8
  • Adopted (+3 from Julien, Victor, Guillaume)
  • Merged : 1c8418eba943b36019fd08cd2be86a3481768444

Summary

Uses codespell to fix most misspellings in source code. This branch contains:

  • A new script in Utilities/Maintenance based on GDAL fix_typos.sh script to apply codespell on OTB source tree
  • Patch for various spelling errors in develop branch (result of the above script

Codespell github page: https://github.com/lucasdemarchi/codespell

Rationale

Use of codespell was suggested by sebastic on Mantis : https://bugs.orfeo-toolbox.org/view.php?id=1259#c3614

The script available in Utilities/Maintenance is based on GDAL one and creates the list of excluded files, get lintian and QGIS dictionnary and apply codespell on OTB source tree The script modifies files in place and is configured in interactive mode (all modifications need to be validate).

Some directories have been excluded for now (Documentation for instance). Some specific rules could be also added in the future to

I would suggest to apply this script before each release.

Retrieved from "https://wiki.orfeo-toolbox.org/index.php?title=Request_for_Changes-61:_Use_codespell_to_fix_common_misspellings_in_source_code&oldid=8722"