fd06efdacd
Putting the explation into the init file docstring ensures that the automated doc builder assigns it to all relevant submodules. Not to mention the help() built-in. Signed-off-by: Jiri Podivin <jpodivin@redhat.com> Change-Id: I9fffae563b721f146123978bf533bc760839b520
14 lines
637 B
Python
14 lines
637 B
Python
"""
|
|
This module contains various callbacks developed to facilitate functions
|
|
of the Validation Framework.
|
|
|
|
Somewhat unorthodox naming of the callback classes is a direct result of how
|
|
ansible handles loading plugins.
|
|
The ansible determines the purpose of each plugin by looking at its class name.
|
|
As you can see in the 'https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/loader.py'
|
|
from the ansible repo, the loader uses the class names to categorize plugins.
|
|
This means that every callback plugin has to have the same class name,
|
|
and the unfortunate coder has to discern their purpose by checking
|
|
their module names.
|
|
"""
|