_help.py now parses yaml files and updates Helpfile objects - #7581

Closed

adewaleo wants to merge 27 commits into

Azure:feature/HelpUpdatefrom

adewaleo:tosin/Help1

Commits on Nov 21, 2018

Dummy help.yaml file
Oluwatosin Adewale
committed
Parse command for testing yaml parsing
Oluwatosin Adewale
committed
Added logic to parse help.yaml file and update help data objects.
Oluwatosin Adewale
committed
_help.py now raises error if it fails to parse help.yaml or help.yaml is empty
Oluwatosin Adewale
committed
updated _help.py: CLI now prints extension messages. Removed parser module.
Oluwatosin Adewale
committed
_help.py: Addressed pep8 warnings. Made some methods static
Oluwatosin Adewale
committed
changed dir to dir_name as dir is a builtin function.
Oluwatosin Adewale
committed
Added some comments. Link urls have title field instad of name field. Command and Group information formatted differently. Addressed a few other PR comments.
Oluwatosin Adewale
committed
Fixed bug in _params_equal()
Oluwatosin Adewale
committed
checked out devs _help.py file.
Oluwatosin Adewale
committed
Refactoring code. Todo: update print_header to print links. Fix bug where some command group names / parameter names are not updated from code.
Oluwatosin Adewale
committed
script to convert _help.py to help/yaml. Parses short and long summaries. Fields within commands/groups need to have some non-alphabetic ordering
Oluwatosin Adewale
committed
Help conversion script uses ruamel.yaml. Output is ordered and visually appealing. '>' and '|' (part of yaml syntax) are preserved in values.
Oluwatosin Adewale
committed
Conversion script now converts parameters to arguments (bug fix). Outputs arguments before examples
Oluwatosin Adewale
committed
Removed unnecessary file.
Oluwatosin Adewale
committed
Addressed style feedback.
Oluwatosin Adewale
committed
Changes:
Oluwatosin Adewale
committed
uncommented help import
Oluwatosin Adewale
committed
Added tests to help script.
Oluwatosin Adewale
committed
PEP8 style changes.
Oluwatosin Adewale
committed
Sphinx properly handles help groups.
Oluwatosin Adewale
committed
Refactored _help.py and _help_util.py to _help_loaders.py
Oluwatosin Adewale
committed
Removed _help_util.py
Oluwatosin Adewale
committed
Bug fixes
Oluwatosin Adewale
committed
More refactoring, script tests pass
Oluwatosin Adewale
committed

Commits on Nov 22, 2018

Changes to restore _help.py to same state before rebase.
Oluwatosin Adewale
committed
Updated AzCliHelp to print links associated with commands and groups.
Oluwatosin Adewale
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

_help.py now parses yaml files and updates Helpfile objects - #7581

_help.py now parses yaml files and updates Helpfile objects#7581
adewaleo wants to merge 27 commits into
Azure:feature/HelpUpdatefrom
adewaleo:tosin/Help1

Commits on Nov 21, 2018

Dummy help.yaml file

Parse command for testing yaml parsing

Added logic to parse help.yaml file and update help data objects.

_help.py now raises error if it fails to parse help.yaml or help.yaml is empty

updated _help.py: CLI now prints extension messages. Removed parser module.

_help.py: Addressed pep8 warnings. Made some methods static

changed dir to dir_name as dir is a builtin function.

Added some comments. Link urls have title field instad of name field. Command and Group information formatted differently. Addressed a few other PR comments.

Fixed bug in _params_equal()

checked out devs _help.py file.

Refactoring code. Todo: update print_header to print links. Fix bug where some command group names / parameter names are not updated from code.

script to convert _help.py to help/yaml. Parses short and long summaries. Fields within commands/groups need to have some non-alphabetic ordering

Help conversion script uses ruamel.yaml. Output is ordered and visually appealing. '>' and '|' (part of yaml syntax) are preserved in values.

Conversion script now converts parameters to arguments (bug fix). Outputs arguments before examples

Removed unnecessary file.

Addressed style feedback.

Changes:

uncommented help import

Added tests to help script.

PEP8 style changes.

Sphinx properly handles help groups.

Refactored _help.py and _help_util.py to _help_loaders.py

Removed _help_util.py

Bug fixes

More refactoring, script tests pass

Commits on Nov 22, 2018

Changes to restore _help.py to same state before rebase.

Updated AzCliHelp to print links associated with commands and groups.