Skip to content

Help.py files should handle/sanitize/not crash with non-ASCII unicode characters #5954

@tjprescott

Description

@tjprescott

Fact of life: we ask non-developers to submit updates for help docs. We have to assume that, not being Python developers:

  1. They aren't Git ninjas
  2. Likely aren't using an IDE but something like Github's in-browser editor
  3. Will definitely use copious amounts of copy/paste

This is a recipe for disaster. Copy/paste does, with startling frequency, dump evil Unicode characters into the text that the CLI loves to crash on. Then trying to debug and fix these issues somehow results in making a simple help change more work than an actual functional code change.

Sooooo... we need to make the help system more resilient to non-ASCII characters.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions