# module document variable for check\_mode

**URL:** <https://forum.ansible.com/t/module-document-variable-for-check-mode/15045>\
**Category:** Ansible Project\
**Created:** [April 18, 2014, 1:39pm UTC](https://forum.ansible.com/t/module-document-variable-for-check-mode/15045 "2014-04-18T13:39:12Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Jeremy\_Schulman](https://avatars.discourse-cdn.com/v4/letter/j/d26b3c/32.png) [@Jeremy\_Schulman](https://forum.ansible.com/u/Jeremy_Schulman)\
**Post date:** [April 18, 2014, 1:39pm UTC](https://forum.ansible.com/t/module-document-variable-for-check-mode/15045/1 "2014-04-18T13:39:12Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![James\_Cammarata](https://avatars.discourse-cdn.com/v4/letter/j/7c8e57/32.png) [@James\_Cammarata](https://forum.ansible.com/u/James_Cammarata)\
**Post date:** [April 18, 2014, 2:46pm UTC](https://forum.ansible.com/t/module-document-variable-for-check-mode/15045/2 "2014-04-18T14:46:01Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![Jeremy\_Schulman](https://avatars.discourse-cdn.com/v4/letter/j/d26b3c/32.png) [@Jeremy\_Schulman](https://forum.ansible.com/u/Jeremy_Schulman)\
**Post date:** [April 18, 2014, 6:48pm UTC](https://forum.ansible.com/t/module-document-variable-for-check-mode/15045/3 "2014-04-18T18:48:41Z")

</div>

@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
