Automated spell-checking in Django projects

Video in TIB AV-Portal: Automated spell-checking in Django projects

Formal Metadata

Title
Automated spell-checking in Django projects
Subtitle
using potypo
Title of Series
Author
License
CC Attribution - NoDerivatives 4.0 International:
You are free to use, copy, distribute and transmit the work or content in unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
2018
Language
English

Content Metadata

Subject Area
Abstract
I'm aiming to show how avoid spelling errors by showing ways to implement automated spell-checking. Nearly all Django applications have two main textual bodies that users come in touch with: First, any text in the application and its translation, second the documentation. Since both are usually written by humans, they will contain spelling errors. This is considered harmful and can from time to time hinder the user trying to understand what to do. Therefore, an automated spell-checking tool should be a part of any CI-cyle. For spell-checking documentation, I will give a short demonstration on how to use the "sphinxcontrib-spelling"-tool written by Doug Hellmann, the problems we had and how we overcame them. For spell-checking text in the application and its translations that are usually found in .po-files, I have implemented a small tool called "potypo" (name and development in progress). I will present this tool and show challenges and problems on the way to implementing automated spell checking for .po-files.
Feedback

Timings

  515 ms - page object

Version

AV-Portal 3.19.2 (70adb5fbc8bbcafb435210ef7d62ffee973cf172)
hidden