> I believe help text is used by argparse and users can see it when they run the pipeline with --help.
This only works when specifically constructing a new PipelineOptions subclass instance from arguments containing --help. This is pretty limited, since it only prints options specific to that subclass. And constructing an instance of the parent class PipelineOptions prints no pipeline options, since PipelineOptions itself contains no options. On Mon, Dec 21, 2020 at 1:13 PM Ahmet Altay <al...@google.com> wrote: > I believe help text is used by argparse and users can see it when they run > the pipeline with --help. > > [1] https://docs.python.org/3/library/argparse.html > > On Mon, Dec 21, 2020 at 1:06 PM Kyle Weaver <kcwea...@google.com> wrote: > >> Java has a similar but less severe problem, where each option's getter >> and setter method are visible in the Javadoc, but the @Description is not. >> e.g. >> https://beam.apache.org/releases/javadoc/2.26.0/index.html?org/apache/beam/runners/direct/DirectOptions.html >> >> On Mon, Dec 21, 2020 at 1:00 PM Kyle Weaver <kcwea...@google.com> wrote: >> >>> Hello Beam developers, >>> >>> I was making some updates to Python's pipeline options documentation >>> when I realized pydoc includes the pipeline options classes, but not their >>> actual options (since option fields are set at runtime) [1]. But we do >>> write a 'help' text for most (all?) of the options. So does anyone know >>> where (if anywhere) we display the help texts? For example, is there any >>> way the user can print them all out, or is there a way we can scrape them >>> to put them on the web? The only way I recall seeing help texts printed out >>> is when I've triggered an argparse error. I'm worried there's a lot of >>> great, mostly up-to-date documentation that is impossible to access without >>> telling everyone to just "use the source." >>> >>> Thanks, >>> Kyle >>> >>> [1] >>> https://beam.apache.org/releases/pydoc/2.26.0/apache_beam.options.pipeline_options.html >>> >>
