4

I know I can use argparse's help string to describe both the general purpose of my script, and its input arguments. Is there also a built-in / conventional method with which I can describe my script's return values?

aon
  • 362
  • 2
  • 10
  • 1
    Do you suppose that user won't understand why he's trying to launch you script? Anyway, there's `description` argument in constructor which usually used as app description (surprisingly). – Olvin Roght Jan 17 '21 at 14:34
  • There's also an `epilog` parameter. You might also want to use the `RawDescriptionFormater` (see the docs for correct name) to preserve newline formatting. The content of these parameters is entirely up to you. – hpaulj Jan 17 '21 at 16:52
  • @OlvinRoght, my intention is not to clarify the script purpose - which I do, indeed, in the description - but to provide more details on the structure of the return values. Does that make things clearer? – aon Jan 19 '21 at 08:19

1 Answers1

1

My conclusion: there isn't a dedicated argument; After scouring the internet, nothing came up. Using the epilog/description is probably your best option.

aon
  • 362
  • 2
  • 10