Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

argparse ArgumentParser kw args confusing translators #126031

Open
rffontenelle opened this issue Oct 27, 2024 · 2 comments
Open

argparse ArgumentParser kw args confusing translators #126031

rffontenelle opened this issue Oct 27, 2024 · 2 comments
Labels
docs Documentation in the Doc dir

Comments

@rffontenelle
Copy link
Contributor

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.

@rffontenelle rffontenelle added the docs Documentation in the Doc dir label Oct 27, 2024
@hugovk
Copy link
Member

hugovk commented Oct 27, 2024

Thanks for the report! What would you suggest, is there a way to mark them as not for translation?

@rffontenelle
Copy link
Contributor Author

rffontenelle commented 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".

@rffontenelle rffontenelle changed the title argparse ArgumentParser kw args confusion translators argparse ArgumentParser kw args confusing translators Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: No status
Development

No branches or pull requests

2 participants