Skip to content

Commit 9aed903

Browse files
authored
Collection requirements: undocumented-parameter must only be used for deprecated parameters or internal parameters (#989)
* undocumented-parameter must only be used for deprecated parameters or internal parameters. * Add newline.
1 parent 6c1ec48 commit 9aed903

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,12 @@ CI Testing
413413
* ``validate-modules:nonexistent-parameter-documented``
414414
* ``validate-modules:parameter-list-no-elements``
415415
* ``validate-modules:parameter-type-not-in-doc``
416-
* ``validate-modules:undocumented-parameter``
416+
417+
* The following validations MUST not be ignored except in specific circumstances:
418+
* ``validate-modules:undocumented-parameter``: this MUST only be ignored in one of these two cases:
419+
420+
1. A dangerous module parameter has been deprecated or removed, and code is present to inform the user that they should not use this specific parameter anymore or that it stopped working intentionally.
421+
2. Module parameters are only used to pass in data from an accompanying action plugin.
417422

418423
* All entries in ignores.txt MUST have a justification in a comment in the ignore.txt file for each entry. For example ``plugins/modules/docker_container.py use-argspec-type-path # uses colon-separated paths, can't use type=path``.
419424
* Reviewers can block acceptance of a new collection if they don't agree with the ignores.txt entries.

0 commit comments

Comments
 (0)