@mcorr Well with respect to CLI, a lot of options simply don’t have any help string/description. See for example:
(pulp) [vagrant@pulp3-source-fedora35 ~]$ pulp deb remote --help
Usage: pulp deb remote [OPTIONS] COMMAND [ARGS]...
Options:
-t, --type [apt]
--help Show this message and exit.
Commands:
create
destroy
label
list
show
update
(pulp) [vagrant@pulp3-source-fedora35 ~]$ pulp deb remote create --help
Usage: pulp deb remote create [OPTIONS]
Create a apt remote.
Options:
--name TEXT [required]
--url TEXT [required]
--ca-cert TEXT a PEM encoded CA certificate or @file
containing same
--client-cert TEXT a PEM encoded client certificate or @file
containing same
--client-key TEXT a PEM encode private key or @file containing
same
--connect-timeout FLOAT
--download-concurrency INTEGER total number of simultaneous connections
--password TEXT
--proxy-url TEXT
--proxy-username TEXT
--proxy-password TEXT
--rate-limit INTEGER limit download rate in requests per second
--sock-connect-timeout FLOAT
--sock-read-timeout FLOAT
--tls-validation BOOLEAN
--total-timeout FLOAT
--username TEXT
--policy [immediate|on_demand|streamed]
--component TEXT Component to sync; can be specified multiple
times. Will sync all available if specified
once with the empty string.
--architecture TEXT Architecture to sync; can be specified
multiple times. Will sync all available if
specified once with the empty string.
--distribution TEXT Distribution to sync; can be specified
multiple times. [required]
--help Show this message and exit.
[required] is added automatically for any required options by the framework. However, beyond this --name, --url, --connect-timeout, --password, and many others don’t have any help strings/descriptions.
I added help strings for the debian specific options --component, --architecture, --distribution, including the phrase “; can be specified multiple times.” which I copied from the rpm cli help. But unlike [required] this phrase is not added by the framework so it will be difficult to use it consistently across plugins.
I guess it looks consistent because most help strings are consistently missing. Then again, maybe many of these options are so self explanatory they don’t need a description?
