classification
Title: Inaccurate explanation of ArgumentParser.add_argument()'s name-or-flags in JA
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.7
process
Status: closed Resolution: third party
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Tatsuo Sekine, docs@python, xtreak
Priority: normal Keywords:

Created on 2019-08-05 07:23 by Tatsuo Sekine, last changed 2019-08-05 07:36 by methane. This issue is now closed.

Messages (2)
msg349031 - (view) Author: Tatsuo Sekine (Tatsuo Sekine) Date: 2019-08-05 07:23
Second sentence of name-or-flags explanation of argparse.ArgumentParser.add_argument() in ja lang. is:

> そのため、add_argument() の第1引数は、フラグのリストか、シンプルな引数名のどちらかになります。
#[1]

while its original English is:

> The first arguments passed to add_argument() must therefore be either a series of flags, or a simple argument name.
# [2]

If I translate Japanese language one back to English, it'd be something:

The first argument passed to add_argument() must therefore be either a list of flags, or a simple argument name.

Japanese one's explanation means, name-or-flags could be either
- "name"
- ["-f", "--flag"]

So, Japanese translation could be improved to clarify that name-of-flags (i.e. first argument*s*) could be either name or *series* (not list) of flags.

Note that, following sentences in the doc have many supporting explanations, and also, there is argparse HOWTO doc with many examples, so this is not critical issue at all.

[1] https://docs.python.org/ja/3/library/argparse.html#name-or-flags
[2] https://docs.python.org/3/library/argparse.html#name-or-flags
msg349032 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2019-08-05 07:27
Japanese translation is tracked as part of GitHub issues at https://github.com/python/python-docs-ja .
History
Date User Action Args
2019-08-05 07:36:24methanesetstatus: open -> closed
resolution: third party
stage: resolved
2019-08-05 07:27:13xtreaksetnosy: + xtreak
messages: + msg349032
2019-08-05 07:23:40Tatsuo Sekinecreate