Help Overhaul project V1. - #8288

Merged

adewaleo merged 48 commits into

Azure:feature/HelpUpdatefrom

adewaleo:tosin/Help1

Jan 23, 2019

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

Commits on Dec 14, 2018

Moved CLIHelp class\'s print method to mixin class. Removed raw value sources field. Added logic to properly update parameter info from data. Updated temp help yaml file example.
Oluwatosin Adewale
committed
WIP: update loader logic/architecture, class structure.
Oluwatosin Adewale
committed
Finish refactoring loader code and help.py
Oluwatosin Adewale
committed

Commits on Dec 17, 2018

updated _load_help_parameters. removed unused get_example_from_data method.
Oluwatosin Adewale
committed

Commits on Jan 3, 2019

Fixed bugs and made updates in help convert script, loader and print methods.
Oluwatosin Adewale
committed

Commits on Jan 11, 2019

Begin loader testing.
Oluwatosin Adewale
committed

Commits on Jan 12, 2019

More testing work.
Oluwatosin Adewale
committed

Commits on Jan 13, 2019

Added tests for loading from help.py
adewaleo
committed

Commits on Jan 15, 2019

Added tests for yaml loader. Fixed bug in example printing. Yaml loader loads files that endwith help.yaml/yml.
Oluwatosin Adewale
committed
Help.py and help.yaml tests are passing. Fixed bug with displaying group help.
Oluwatosin Adewale
committed
All help tests pass. Including test of new help loader.
Oluwatosin Adewale
committed

Commits on Jan 16, 2019

BaseHelpLoader now inherits from ABC. Loaders now check if data version matches their version.
Oluwatosin Adewale
committed

Commits on Jan 17, 2019

Updated doc generator script. Updated yaml converter test.
Oluwatosin Adewale
committed

Commits on Jan 18, 2019

Fix bug in doc gen script.
Oluwatosin Adewale
committed

Commits on Jan 19, 2019

Optimize help conversion script. Added logic to convert all core modules.
Oluwatosin Adewale
committed
Removed unnecessary check.
Oluwatosin Adewale
committed
Script updates. Yaml, no longer wraps around. Handles duplicate keys. Handles incorect module names.
Oluwatosin Adewale
committed
Can delete files, bug in loading multiple modules due to duplicate keys in repo. See acs create.
Oluwatosin Adewale
committed

Commits on Jan 22, 2019

Commits on Jan 23, 2019

Added license header to convert_all.py
Oluwatosin Adewale
committed