You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docsite/rst/dev_guide/plugins_documenting.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Not all plugins can be documented, but those that can (`documentable <https://gi
8
8
9
9
This document will describe how the plugin configuration works in general, excluding modules, which have their own `documentation reference:developing_modules_documenting`.
10
10
11
-
.. note:: While most plugins support having the documentation in YAML format inside the same Python code file, filters and tests also suport an 'adjacent' YAML file as both of those plugins also support having multiple of them defined in the same file.
11
+
.. note:: While most plugins support having the documentation in YAML format inside the same Python code file, filters and tests also support an 'adjacent' YAML file as both of those plugins also support having multiple of them defined in the same file.
12
12
With YAML files, the examples below are easy to use by removing Python quoting and substituting ``=`` for ``:``, for example ``DOCUMENTATION = r''' ... '''` ` to ``DOCUMENTATION: ...`` and removing closing quotes. :ref:`adjacent_yaml_doc`
0 commit comments