PR#35: search-containers: --help text improvements - koji-tools

koji-tools

#35 search-containers: --help text improvements

Merged 6 years ago by tkopecek. Opened 6 years ago by ktdreyer.

ktdreyer/koji-tools search-containers-help into master

koji-search-containers: add examples to --help text

Ken Dreyer • 6 years ago

7f6dc31

koji-search-containers: expand help text for --profile

Ken Dreyer • 6 years ago

3826a48

koji-search-containers: use default help formatter

Ken Dreyer • 6 years ago

e67f20d

src/bin/koji-search-containers

file modified

+8 -6

		`@@ -1,7 +1,6 @@`
		`#!/usr/bin/python3`

		`import argparse`
		`- from argparse import RawTextHelpFormatter`
		`import koji`
		`from requests import Session`
		`import posixpath`
		`@@ -121,16 +120,19 @@`


		`def parse_args():`
		`- parser = argparse.ArgumentParser(description=DESCRIPTION,`
		`- formatter_class=RawTextHelpFormatter)`
		`+ parser = argparse.ArgumentParser(description=DESCRIPTION)`
		`parser.add_argument('--profile',`
		`- help='Koji profile',`
		`+ help='Koji profile. Your Koji client profile'`
		`+ ' definitions are stored in'`
		`+ ' /etc/koji.conf.d/*.conf.',`
		`required=True)`
		`parser.add_argument('--nvr',`
		`- help='RPM build NVR to search',`
		`+ help='RPM build NVR to search, eg '`
		`+ ' "ceph-14.2.4-3.fc32"',`
		`required=True)`
		`parser.add_argument('--container',`
		`- help='container package name to search',`
		`+ help='container package name to search, eg'`
		`+ ' "rhceph-container".',`
		`required=True)`
		`args = parser.parse_args()`

ktdreyer commented 6 years ago

Improve the --help text for koji-search-containers:

1) Use argparse's default help formatter
2) Expand the help text for the --profile argument. This makes the tool easier for new Koji users.
3) Give example values for the --nvr and --container command-line arguments.