Repository navigation
argparse ArgumentParser kw args confusing translators #126031
Description
Documentation
ArgumentParser documentation has subsections to detail its keyword arguments (prog, usage, description, etc.). These subsection titles are extracted for translation, and they confuse translators: they look like a normal text that one should translate (e.g. "description"). See how it looks in the extracted strings.
Activity
hugovk commentedon Oct 27, 2024
Thanks for the report! What would you suggest, is there a way to mark them as not for translation?
rffontenelle commentedon Oct 27, 2024
I don't know if it is possible to mark as untranslatable, but we could add some markup like
*description*and``description``. I would be a disambiguation and be a great suggestion "do not translation".[-]argparse ArgumentParser kw args confusion translators[/-][+]argparse ArgumentParser kw args confusing translators[/+]merwok commentedon Sep 19, 2025
Is there a mecanism for translators comment in the markup?
(that get extracted and output to the po files)
StanFromIreland commentedon Nov 24, 2025
No :-(
You can add a comment on Transifex (e.g. the provided example), but you'll have to do it for each string, and that only covers some of the translations since we don't all use it.
savannahostrowski commentedon Mar 17, 2026
Just circling back on this one - is there really anything we can do here? I'm not a translations expert so I'm not sure on the feasibility of this.
zware commentedon Mar 17, 2026
This (particularly the latter, code formatting) seems like a reasonable approach to me.
picnixz commentedon Mar 18, 2026
I think we have a
no-translatedirective option but I do not remember whether it worked when using.. rubric::(we could switch to using rubric instead of titles)picnixz commentedon Mar 18, 2026
Nevermind, the no-translate was a feature request. Let me see if we can do something else apart from using markup while keeping title-like sections
hugovk commentedon Mar 20, 2026
For reference, here's the feature request: sphinx-doc/sphinx#1608.
pythongh-126031: Format add_argument parameter headings as code