Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

plugin_formatter: Check if docs are present for given plugin #53743

Merged
merged 1 commit into from Mar 20, 2019

Conversation

Projects
None yet
3 participants
@Akasurde
Copy link
Member

Akasurde commented Mar 13, 2019

SUMMARY

Signed-off-by: Abhijeet Kasurde akasurde@redhat.com

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

docs/bin/plugin_formatter.py

ADDITIONAL INFORMATION

Before:

$ PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --plugin-type cliconf --template-dir=../templates --module-dir=../../lib/ansible/plugins/cliconf -o rst
Evaluating cliconf files...
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 779, in <module>
    main()
  File "../bin/plugin_formatter.py", line 734, in main
    plugin_info, categories = get_plugin_info(options.module_dir, limit_to=options.limit_to, verbose=(options.verbosity > 0))
  File "../bin/plugin_formatter.py", line 324, in get_plugin_info
    if 'options' in doc and doc['options'] is None:
TypeError: argument of type 'NoneType' is not iterable

After

$ PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --plugin-type cliconf --template-dir=../templates --module-dir=../../lib/ansible/plugins/cliconf -o rst
Evaluating cliconf files...
 [ERROR]: *** ERROR: DOCUMENTATION section missing for ../../lib/ansible/plugins/cliconf/netvisor.py. ***
plugin_formatter: Check if docs are present for given plugin
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Mar 13, 2019

@bcoca

bcoca approved these changes Mar 19, 2019

@ansibot ansibot removed the needs_triage label Mar 19, 2019

@Akasurde Akasurde merged commit 943946e into ansible:devel Mar 20, 2019

1 check passed

Shippable Run 113800 status is SUCCESS.
Details

@Akasurde Akasurde deleted the Akasurde:missing_doc branch Mar 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.