From 8d39332c3dbe21363a7f6779584495265c585d72 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Tue, 1 Jun 2021 23:16:04 +0530 Subject: [PATCH] plugins: specify plugin types for get_option (#74799) --- docs/docsite/rst/dev_guide/developing_plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_plugins.rst b/docs/docsite/rst/dev_guide/developing_plugins.rst index 982924e601e..1c9ed64f623 100644 --- a/docs/docsite/rst/dev_guide/developing_plugins.rst +++ b/docs/docsite/rst/dev_guide/developing_plugins.rst @@ -68,7 +68,7 @@ To define configurable options for your plugin, describe them in the ``DOCUMENTA type: boolean/float/integer/list/none/path/pathlist/pathspec/string/tmppath version_added: X.x -To access the configuration settings in your plugin, use ``self.get_option()``. For most plugin types, the controller pre-populates the settings. If you need to populate settings explicitly, use a ``self.set_options()`` call. +To access the configuration settings in your plugin, use ``self.get_option()``. For the plugin types (such as 'become', 'cache', 'callback', 'cliconf', 'connection', 'httpapi', 'inventory', 'lookup', 'netconf', 'shell', and 'vars') that support embedded documentation, the controller pre-populates the settings. If you need to populate settings explicitly, use a ``self.set_options()`` call. Plugins that support embedded documentation (see :ref:`ansible-doc` for the list) should include well-formed doc strings. If you inherit from a plugin, you must document the options it takes, either via a documentation fragment or as a copy. See :ref:`module_documenting` for more information on correct documentation. Thorough documentation is a good idea even if you're developing a plugin for local use.