module document variable for check_mode

Archives Ansible Project
1

Hi Team,

I am writing modules and in the process of writing the DOCUMENTATION and EXAMPLE strings. Is there a way to indicate whether or not the module support check_mode so that folks can find this out from looking at the webdocs?

Thank you!
– Jeremy

2

There is a ‘notes:’ (which should be an array of strings) section in the DOCUMENTATION string, but I don’t believe we have anything official in the document generator for that.

3

@James,

Thank you for the prompt reply. Just wanted to make sure I didn’t miss anything as I am developing these modules.

I think it would be a great addition to make to the auto-doc system, if/when you guys decide to do work in that area.

Cheers,
– Jeremy