pywbem / pywbemtools / test-2891

93%

push

github

Modify tab-completion activation doc per issue 1524 (#1539)

* Modify tab-completion activation doc per pr 1524

Simplifies the documentation for activation of tab-completion for both
pywbemcli and pywbemlistener to document only the eval method.

Not that this does not remove the other method but creates an extra
section at the bottom of the tab-completion section noting that this
is only for special circumstances.

Also the activation of both pywbemcli and pywbemlistener eval statements
is shown together in both pywbemcli and pywbemlistener documentation
just to be sure users understand that each has a separate statement.

Modifies the pywbemcli help activate and pywbemlistener help activate
commands to simplify them.

changes to tab-completion documentation to simplify it

1. Modify docs/settingandconfig to remove the documentation on
activating tab-completion by directly writing the file from the current
location and only document the `eval` method.  The documentation on
directly writing the tab COMPLETE file is set at the very end of the
section noting that it should only be used in special circumstances.

Modified the files for _cmd_help for pywbemcli and pywbemlistener to
reflect only the 'eval' method.

Modify pywbemcli help command help

Cleaned up the help description for pywbemcli help command.

* Extend definition of the command line in doc

Extends the definition of the command line in pywbemlistener doc to
define the parts of the command.

Syntax fixes for the command line definition in pywbemcli doc

* is a combination of 2 commits.
 is the 1st commit message:

Issues from comments. Make minor fixes for doc
an grammar issues in other doc files.

 is the commit message #2:

Fix issues with referencing Tables

Could not find a reasonable way to reference tables from the text so
removed the references and use "in the table below"

Clarify the text of alternate activation.

Rewrote the alternate activation definition to a) remove the table ... (continued)

1 of 1 new or added line in 1 file covered. (100.0%)

6126 of 6604 relevant lines covered (92.76%)

10.0 hits per line