Update iptables.py

[dshuvar]

SUMMARY

Added to documentation the required variable 'protocol' for variable destination_port.

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

iptables.py

ANSIBLE VERSION

ansible 2.5.4

ADDITIONAL INFORMATION

if does not use variable 'protocol' you can see error:
iptables v1.6.0: unknown option "--destination-port"
like in https://github.com/ansible/ansible-modules-extras/issues/2100
it means need notes about obligate variable in documentation of module.

[ansibot]

cc @LinusU @sebastiendarocha
click here for bot help

[sebastiendarocha]

You can't put a ":" on documation, it's yaml so it considers the line as a dict.
You have to encapsulate the line between quotes (see "description" of the parameter "to_ports")

[ansibot]

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/system/iptables.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/system/iptables.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/system/iptables.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/system/iptables.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/system/iptables.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "test/sanity/code-smell/docs-build.py", line 101, in <module>
    main()
  File "test/sanity/code-smell/docs-build.py", line 17, in main
    raise subprocess.CalledProcessError(sphinx.returncode, cmd, output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['make', 'singlehtmldocs']' returned non-zero exit status 2.

The test ansible-test sanity --test validate-modules [explain] failed with 6 errors:

lib/ansible/modules/system/iptables.py:0:0: E324 Value for "default" from the argument_spec ('append') for "action" does not match the documentation (None)
lib/ansible/modules/system/iptables.py:0:0: E324 Value for "default" from the argument_spec ('filter') for "table" does not match the documentation (None)
lib/ansible/modules/system/iptables.py:0:0: E324 Value for "default" from the argument_spec ('ignore') for "syn" does not match the documentation (None)
lib/ansible/modules/system/iptables.py:0:0: E324 Value for "default" from the argument_spec ('ipv4') for "ip_version" does not match the documentation (None)
lib/ansible/modules/system/iptables.py:0:0: E324 Value for "default" from the argument_spec ('present') for "state" does not match the documentation (None)
lib/ansible/modules/system/iptables.py:187:18: E302 DOCUMENTATION is not valid YAML

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/system/iptables.py:187:18: error DOCUMENTATION: syntax error: mapping values are not allowed here

click here for bot help

[dshuvar]

@sebastiendarocha thank you, I forgot about double quotes and already fix it.

[sebastiendarocha]

shipit

Thanx :)

[LinusU]

shipit

👍

[resmo]

To me it looks like we should enforce this in the code (or fail early). Would this make sense?

[dshuvar]

It makes sense because if you regularly use this role you know how right use this option,
but if you saw or use in the first time this module you with a high probability make mistake.
Documentation and feature which you use must be been able to evident.