config: Accept string values 0 and 1 for 'translation_progress_classes' option - Githubissues

sphinx-doc / sphinx

The Sphinx documentation generator

https://www.sphinx-doc.org/

Other

6.61k stars 2.13k forks source link

config: Accept string values 0 and 1 for 'translation_progress_classes' option #13074

Closed jayaddison closed 3 weeks ago

jayaddison commented 4 weeks ago

Feature or Bugfix

Bugfix

Purpose

Allow the translation_progress_classes config option, that is documented as accepting boolean values, accept the string values 0 or 1 as documented for boolean options.

Detail

Allow the translation_progress_classes configuration option to be specified using the define (type: str) command-line option.
This isn't as trivial as it might seem; the values read are strings, not integer values -- and naively boolean casting the string '0' would result in a True value. Also, there is an existing falsiness test -- so, technically speaking, the introduction of a comparison to False is redundant in this changeset.

Relates

Resolves #13071.
Relates-to #11509.

jayaddison commented 3 weeks ago

I think I might opt against implementing this myself, at least for now; too many other things going on at the moment, so I'd like to remove this from the stack. I think we've gathered most of the requirements, and anyone is welcome to pick up from the branch here so far.