Fix Ansible documentation in part of example formatting. Part 2 (#333)

* Fix Ansible documentation in part of example formatting

* fix

* Revert osx_defaults.py

plugins/modules/packaging/os/apk.py

@@ -58,63 +58,63 @@ notes:
 '''
 
 EXAMPLES = '''
-# Update repositories and install "foo" package
+- name: Update repositories and install foo package
-- apk:
+  apk:
     name: foo
     update_cache: yes
 
-# Update repositories and install "foo" and "bar" packages
+- name: Update repositories and install foo and bar packages
-- apk:
+  apk:
     name: foo,bar
     update_cache: yes
 
-# Remove "foo" package
+- name: Remove foo package
-- apk:
+  apk:
     name: foo
     state: absent
 
-# Remove "foo" and "bar" packages
+- name: Remove foo and bar packages
-- apk:
+  apk:
     name: foo,bar
     state: absent
 
-# Install the package "foo"
+- name: Install the package foo
-- apk:
+  apk:
     name: foo
     state: present
 
-# Install the packages "foo" and "bar"
+- name: Install the packages foo and bar
-- apk:
+  apk:
     name: foo,bar
     state: present
 
-# Update repositories and update package "foo" to latest version
+- name: Update repositories and update package foo to latest version
-- apk:
+  apk:
     name: foo
     state: latest
     update_cache: yes
 
-# Update repositories and update packages "foo" and "bar" to latest versions
+- name: Update repositories and update packages foo and bar to latest versions
-- apk:
+  apk:
     name: foo,bar
     state: latest
     update_cache: yes
 
-# Update all installed packages to the latest versions
+- name: Update all installed packages to the latest versions
-- apk:
+  apk:
     upgrade: yes
 
-# Upgrade / replace / downgrade / uninstall all installed packages to the latest versions available
+- name: Upgrade / replace / downgrade / uninstall all installed packages to the latest versions available
-- apk:
+  apk:
     available: yes
     upgrade: yes
 
-# Update repositories as a separate step
+- name: Update repositories as a separate step
-- apk:
+  apk:
     update_cache: yes
 
-# Install package from a specific repository
+- name: Install package from a specific repository
-- apk:
+  apk:
     name: foo
     state: latest
     update_cache: yes

plugins/modules/packaging/os/homebrew_tap.py

@@ -49,18 +49,22 @@ requirements: [ homebrew ]
 '''
 
 EXAMPLES = '''
-- homebrew_tap:
+- name: Tap a Homebrew repository, state present
+  homebrew_tap:
     name: homebrew/dupes
 
-- homebrew_tap:
+- name: Tap a Homebrew repository, state absent
+  homebrew_tap:
     name: homebrew/dupes
     state: absent
 
-- homebrew_tap:
+- name: Tap a Homebrew repository, state present
+  homebrew_tap:
     name: homebrew/dupes,homebrew/science
     state: present
 
-- homebrew_tap:
+- name: Tap a Homebrew repository using url, state present
+  homebrew_tap:
     name: telemachus/brew
     url: 'https://bitbucket.org/telemachus/brew'
 '''

plugins/modules/packaging/os/layman.py

@@ -46,28 +46,28 @@ options:
 '''
 
 EXAMPLES = '''
-# Install the overlay 'mozilla' which is on the central overlays list.
+- name: Install the overlay mozilla which is on the central overlays list
-- layman:
+  layman:
     name: mozilla
 
-# Install the overlay 'cvut' from the specified alternative list.
+- name: Install the overlay cvut from the specified alternative list
-- layman:
+  layman:
     name: cvut
     list_url: 'http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml'
 
-# Update (sync) the overlay 'cvut', or install if not installed yet.
+- name: Update (sync) the overlay cvut or install if not installed yet
-- layman:
+  layman:
     name: cvut
     list_url: 'http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml'
     state: updated
 
-# Update (sync) all of the installed overlays.
+- name: Update (sync) all of the installed overlays
-- layman:
+  layman:
     name: ALL
     state: updated
 
-# Uninstall the overlay 'cvut'.
+- name: Uninstall the overlay cvut
-- layman:
+  layman:
     name: cvut
     state: absent
 '''

plugins/modules/packaging/os/opkg.py

@@ -53,24 +53,29 @@ requirements:
     - python
 '''
 EXAMPLES = '''
-- opkg:
+- name: Install foo
+  opkg:
     name: foo
     state: present
 
-- opkg:
+- name: Update cache and install foo
+  opkg:
     name: foo
     state: present
     update_cache: yes
 
-- opkg:
+- name: Remove foo
+  opkg:
     name: foo
     state: absent
 
-- opkg:
+- name: Remove foo and bar
+  opkg:
     name: foo,bar
     state: absent
 
-- opkg:
+- name: Install foo using overwrite option forcibly
+  opkg:
     name: foo
     state: present
     force: overwrite

plugins/modules/packaging/os/pkg5_publisher.py

@@ -48,14 +48,14 @@ options:
       - Multiple values may be provided.
 '''
 EXAMPLES = '''
-# Fetch packages for the solaris publisher direct from Oracle:
+- name: Fetch packages for the solaris publisher direct from Oracle
-- pkg5_publisher:
+  pkg5_publisher:
     name: solaris
     sticky: true
     origin: https://pkg.oracle.com/solaris/support/
 
-# Configure a publisher for locally-produced packages:
+- name: Configure a publisher for locally-produced packages
-- pkg5_publisher:
+  pkg5_publisher:
     name: site
     origin: 'https://pkg.example.com/site/'
 '''

plugins/modules/packaging/os/pkgin.py

@@ -68,45 +68,45 @@ options:
 '''
 
 EXAMPLES = '''
-# install package foo
+- name: Install package foo
-- pkgin:
+  pkgin:
     name: foo
     state: present
 
-# Update database and install "foo" package
+- name: Update cache and install foo package
-- pkgin:
+  pkgin:
     name: foo
     update_cache: yes
 
-# remove package foo
+- name: Remove package foo
-- pkgin:
+  pkgin:
     name: foo
     state: absent
 
-# remove packages foo and bar
+- name: Remove packages foo and bar
-- pkgin:
+  pkgin:
     name: foo,bar
     state: absent
 
-# Update repositories as a separate step
+- name: Update repositories as a separate step
-- pkgin:
+  pkgin:
     update_cache: yes
 
-# Upgrade main packages (equivalent to C(pkgin upgrade))
+- name: Upgrade main packages (equivalent to pkgin upgrade)
-- pkgin:
+  pkgin:
     upgrade: yes
 
-# Upgrade all packages (equivalent to C(pkgin full-upgrade))
+- name: Upgrade all packages (equivalent to pkgin full-upgrade)
-- pkgin:
+  pkgin:
     full_upgrade: yes
 
-# Force-upgrade all packages (equivalent to C(pkgin -F full-upgrade))
+- name: Force-upgrade all packages (equivalent to pkgin -F full-upgrade)
-- pkgin:
+  pkgin:
     full_upgrade: yes
     force: yes
 
-# clean packages cache (equivalent to C(pkgin clean))
+- name: Clean packages cache (equivalent to pkgin clean)
-- pkgin:
+  pkgin:
     clean: yes
 '''
 

plugins/modules/packaging/os/pkgutil.py

@@ -48,13 +48,13 @@ options:
 '''
 
 EXAMPLES = '''
-# Install a package
+- name: Install a package
-- pkgutil:
+  pkgutil:
     name: CSWcommon
     state: present
 
-# Install a package from a specific repository
+- name: Install a package from a specific repository
-- pkgutil:
+  pkgutil:
     name: CSWnrpe
     site: 'ftp://myinternal.repo/opencsw/kiel'
     state: latest

plugins/modules/packaging/os/portage.py

@@ -164,44 +164,44 @@ author:
 '''
 
 EXAMPLES = '''
-# Make sure package foo is installed
+- name: Make sure package foo is installed
-- portage:
+  portage:
     package: foo
     state: present
 
-# Make sure package foo is not installed
+- name: Make sure package foo is not installed
-- portage:
+  portage:
     package: foo
     state: absent
 
-# Update package foo to the "latest" version ( os specific alternative to latest )
+- name: Update package foo to the latest version (os specific alternative to latest)
-- portage:
+  portage:
     package: foo
     update: yes
 
-# Install package foo using PORTAGE_BINHOST setup
+- name: Install package foo using PORTAGE_BINHOST setup
-- portage:
+  portage:
     package: foo
     getbinpkg: yes
 
-# Re-install world from binary packages only and do not allow any compiling
+- name: Re-install world from binary packages only and do not allow any compiling
-- portage:
+  portage:
     package: '@world'
     usepkgonly: yes
 
-# Sync repositories and update world
+- name: Sync repositories and update world
-- portage:
+  portage:
     package: '@world'
     update: yes
     deep: yes
     sync: yes
 
-# Remove unneeded packages
+- name: Remove unneeded packages
-- portage:
+  portage:
     depclean: yes
 
-# Remove package foo if it is not explicitly needed
+- name: Remove package foo if it is not explicitly needed
-- portage:
+  portage:
     package: foo
     state: absent
     depclean: yes

plugins/modules/packaging/os/portinstall.py

@@ -38,18 +38,18 @@ author: "berenddeboer (@berenddeboer)"
 '''
 
 EXAMPLES = '''
-# Install package foo
+- name: Install package foo
-- portinstall:
+  portinstall:
     name: foo
     state: present
 
-# Install package security/cyrus-sasl2-saslauthd
+- name: Install package security/cyrus-sasl2-saslauthd
-- portinstall:
+  portinstall:
     name: security/cyrus-sasl2-saslauthd
     state: present
 
-# Remove packages foo and bar
+- name: Remove packages foo and bar
-- portinstall:
+  portinstall:
     name: foo,bar
     state: absent
 '''

plugins/modules/packaging/os/rhn_channel.py

@@ -53,7 +53,8 @@ options:
 '''
 
 EXAMPLES = '''
-- rhn_channel:
+- name: Add a Red Hat software channel
+  rhn_channel:
     name: rhel-x86_64-server-v2vwin-6
     sysname: server01
     url: https://rhn.redhat.com/rpc/api

plugins/modules/packaging/os/slackpkg.py

@@ -46,18 +46,18 @@ requirements: [ "Slackware >= 12.2" ]
 '''
 
 EXAMPLES = '''
-# Install package foo
+- name: Install package foo
-- slackpkg:
+  slackpkg:
     name: foo
     state: present
 
-# Remove packages foo and bar
+- name: Remove packages foo and bar
-- slackpkg:
+  slackpkg:
     name: foo,bar
     state: absent
 
-# Make sure that it is the most updated package
+- name: Make sure that it is the most updated package
-- slackpkg:
+  slackpkg:
     name: foo
     state: latest
 '''

plugins/modules/packaging/os/sorcery.py

@@ -74,36 +74,36 @@ options:
 
 
 EXAMPLES = '''
-# Make sure spell 'foo' is installed
+- name: Make sure spell foo is installed
-- sorcery:
+  sorcery:
     spell: foo
     state: present
 
-# Make sure spells 'foo', 'bar' and 'baz' are removed
+- name: Make sure spells foo, bar and baz are removed
-- sorcery:
+  sorcery:
     spell: foo,bar,baz
     state: absent
 
-# Make sure spell 'foo' with dependencies 'bar' and 'baz' is installed
+- name: Make sure spell foo with dependencies bar and baz is installed
-- sorcery:
+  sorcery:
     spell: foo
     depends: bar,baz
     state: present
 
-# Make sure spell 'foo' with 'bar' and without 'baz' dependencies is installed
+- name: Make sure spell foo with bar and without baz dependencies is installed
-- sorcery:
+  sorcery:
     spell: foo
     depends: +bar,-baz
     state: present
 
-# Make sure spell 'foo' with libressl (providing SSL) dependency is installed
+- name: Make sure spell foo with libressl (providing SSL) dependency is installed
-- sorcery:
+  sorcery:
     spell: foo
     depends: libressl(SSL)
     state: present
 
-# Playbook: make sure spells with/without required dependencies (if any) are installed
+- name: Make sure spells with/without required dependencies (if any) are installed
-- sorcery:
+  sorcery:
     name: "{{ item.spell }}"
     depends: "{{ item.depends | default(None) }}"
     state: present
@@ -112,30 +112,30 @@ EXAMPLES = '''
     - { spell: 'fwknop', depends: 'gpgme' }
     - { spell: 'pv,tnftp,tor' }
 
-# Install the latest version of spell 'foo' using regular glossary
+- name: Install the latest version of spell foo using regular glossary
-- sorcery:
+  sorcery:
     name: foo
     state: latest
 
-# Rebuild spell 'foo'
+- name: Rebuild spell foo
-- sorcery:
+  sorcery:
     spell: foo
     state: rebuild
 
-# Rebuild the whole system, but update Sorcery and Codex first
+- name: Rebuild the whole system, but update Sorcery and Codex first
-- sorcery:
+  sorcery:
     spell: '*'
     state: rebuild
     update: yes
     update_cache: yes
 
-# Refresh the grimoire collection if it's 1 day old using native sorcerous alias
+- name: Refresh the grimoire collection if it is 1 day old using native sorcerous alias
-- sorcery:
+  sorcery:
     update_codex: yes
     cache_valid_time: 86400
 
-# Update only Sorcery itself
+- name: Update only Sorcery itself
-- sorcery:
+  sorcery:
     update: yes
 '''
 

plugins/modules/packaging/os/svr4pkg.py

@@ -61,33 +61,33 @@ options:
 '''
 
 EXAMPLES = '''
-# Install a package from an already copied file
+- name: Install a package from an already copied file
-- svr4pkg:
+  svr4pkg:
     name: CSWcommon
     src: /tmp/cswpkgs.pkg
     state: present
 
-# Install a package directly from an http site
+- name: Install a package directly from an http site
-- svr4pkg:
+  svr4pkg:
     name: CSWpkgutil
     src: 'http://get.opencsw.org/now'
     state: present
     zone: current
 
-# Install a package with a response file
+- name: Install a package with a response file
-- svr4pkg:
+  svr4pkg:
     name: CSWggrep
     src: /tmp/third-party.pkg
     response_file: /tmp/ggrep.response
     state: present
 
-# Ensure that a package is not installed.
+- name: Ensure that a package is not installed
-- svr4pkg:
+  svr4pkg:
     name: SUNWgnome-sound-recorder
     state: absent
 
-# Ensure that a category is not installed.
+- name: Ensure that a category is not installed
-- svr4pkg:
+  svr4pkg:
     name: FIREFOX
     state: absent
     category: true

plugins/modules/packaging/os/swdepot.py

@@ -35,17 +35,20 @@ options:
 '''
 
 EXAMPLES = '''
-- swdepot:
+- name: Install a package
+  swdepot:
     name: unzip-6.0
     state: present
     depot: 'repository:/path'
 
-- swdepot:
+- name: Install the latest version of a package
+  swdepot:
     name: unzip
     state: latest
     depot: 'repository:/path'
 
-- swdepot:
+- name: Remove a package
+  swdepot:
     name: unzip
     state: absent
 '''

plugins/modules/remote_management/hpilo/hpilo_info.py

@@ -46,8 +46,8 @@ notes:
 '''
 
 EXAMPLES = r'''
-# Task to gather facts from a HP iLO interface only if the system is an HP server
+- name: Gather facts from a HP iLO interface only if the system is an HP server
-- hpilo_info:
+  hpilo_info:
     host: YOUR_ILO_ADDRESS
     login: YOUR_ILO_LOGIN
     password: YOUR_ILO_PASSWORD

plugins/modules/remote_management/ipmi/ipmi_boot.py

@@ -88,15 +88,15 @@ uefimode:
 '''
 
 EXAMPLES = '''
-# Ensure bootdevice is HD.
+- name: Ensure bootdevice is HD
-- ipmi_boot:
+  ipmi_boot:
     name: test.testdomain.com
     user: admin
     password: password
     bootdev: hd
 
-# Ensure bootdevice is not Network
+- name: Ensure bootdevice is not Network
-- ipmi_boot:
+  ipmi_boot:
     name: test.testdomain.com
     user: admin
     password: password

plugins/modules/remote_management/ipmi/ipmi_power.py

@@ -60,8 +60,8 @@ powerstate:
 '''
 
 EXAMPLES = '''
-# Ensure machine is powered on.
+- name: Ensure machine is powered on
-- ipmi_power:
+  ipmi_power:
     name: test.testdomain.com
     user: admin
     password: password

plugins/modules/source_control/bzr.py

@@ -45,8 +45,8 @@ options:
 '''
 
 EXAMPLES = '''
-# Example bzr checkout from Ansible Playbooks
+- name: Checkout
-- bzr:
+  bzr:
     name: bzr+ssh://foosball.example.org/path/to/branch
     dest: /srv/checkout
     version: 22

plugins/modules/source_control/git_config.py

@@ -59,70 +59,73 @@ options:
 '''
 
 EXAMPLES = '''
-# Set some settings in ~/.gitconfig
+- name: Add a setting to ~/.gitconfig
-- git_config:
+  git_config:
     name: alias.ci
     scope: global
     value: commit
 
-- git_config:
+- name: Add a setting to ~/.gitconfig
+  git_config:
     name: alias.st
     scope: global
     value: status
 
-# Unset some settings in ~/.gitconfig
+- name: Remove a setting from ~/.gitconfig
-- git_config:
+  git_config:
     name: alias.ci
     scope: global
     state: absent
 
-# Or system-wide:
+- name: Add a setting to ~/.gitconfig
-- git_config:
+  git_config:
-    name: alias.remotev
-    scope: system
-    value: remote -v
-
-- git_config:
     name: core.editor
     scope: global
     value: vim
 
-# scope=system is the default
+- name: Add a setting system-wide
-- git_config:
+  git_config:
+    name: alias.remotev
+    scope: system
+    value: remote -v
+
+- name: Add a setting to a system scope (default)
+  git_config:
     name: alias.diffc
     value: diff --cached
 
-- git_config:
+- name: Add a setting to a system scope (default)
+  git_config:
     name: color.ui
     value: auto
 
-# Make etckeeper not complain when invoked by cron
+- name: Make etckeeper not complaining when it is invoked by cron
-- git_config:
+  git_config:
     name: user.email
     repo: /etc
     scope: local
     value: 'root@{{ ansible_fqdn }}'
 
-# Read individual values from git config
+- name: Read individual values from git config
-- git_config:
+  git_config:
     name: alias.ci
     scope: global
 
-# scope: system is also assumed when reading values, unless list_all=yes
+- name: Scope system is also assumed when reading values, unless list_all=yes
-- git_config:
+  git_config:
     name: alias.diffc
 
-# Read all values from git config
+- name: Read all values from git config
-- git_config:
+  git_config:
     list_all: yes
     scope: global
 
-# When list_all=yes and no scope is specified, you get configuration from all scopes
+- name: When list_all is yes and no scope is specified, you get configuration from all scopes
-- git_config:
+  git_config:
     list_all: yes
 
-# Specify a repository to include local settings
+- name: Specify a repository to include local settings
-- git_config:
+  git_config:
     list_all: yes
     repo: /path/to/repo.git
 '''

plugins/modules/source_control/github/github_deploy_key.py

@@ -75,8 +75,8 @@ notes:
 '''
 
 EXAMPLES = '''
-# add a new read-only deploy key to a GitHub repository using basic authentication
+- name: Add a new read-only deploy key to a GitHub repository using basic authentication
-- github_deploy_key:
+  github_deploy_key:
     owner: "johndoe"
     repo: "example"
     name: "new-deploy-key"
@@ -85,8 +85,8 @@ EXAMPLES = '''
     username: "johndoe"
     password: "supersecretpassword"
 
-# remove an existing deploy key from a GitHub repository
+- name: Remove an existing deploy key from a GitHub repository
-- github_deploy_key:
+  github_deploy_key:
     owner: "johndoe"
     repository: "example"
     name: "new-deploy-key"
@@ -96,8 +96,8 @@ EXAMPLES = '''
     password: "supersecretpassword"
     state: absent
 
-# add a new deploy key to a GitHub repository, replace an existing key, use an OAuth2 token to authenticate
+- name: Add a new deploy key to a GitHub repository, replace an existing key, use an OAuth2 token to authenticate
-- github_deploy_key:
+  github_deploy_key:
     owner: "johndoe"
     repository: "example"
     name: "new-deploy-key"
@@ -105,8 +105,8 @@ EXAMPLES = '''
     force: yes
     token: "ABAQDAwXxn7kIMNWzcDfo..."
 
-# re-add a deploy key to a GitHub repository but with a different name
+- name: Re-add a deploy key to a GitHub repository but with a different name
-- github_deploy_key:
+  github_deploy_key:
     owner: "johndoe"
     repository: "example"
     name: "replace-deploy-key"
@@ -114,8 +114,8 @@ EXAMPLES = '''
     username: "johndoe"
     password: "supersecretpassword"
 
-# add a new deploy key to a GitHub repository using 2FA
+- name: Add a new deploy key to a GitHub repository using 2FA
-- github_deploy_key:
+  github_deploy_key:
     owner: "johndoe"
     repo: "example"
     name: "new-deploy-key-2"
@@ -124,8 +124,8 @@ EXAMPLES = '''
     password: "supersecretpassword"
     otp: 123456
 
-# add a read-only deploy key to a repository hosted on GitHub Enterprise
+- name: Add a read-only deploy key to a repository hosted on GitHub Enterprise
-- github_deploy_key:
+  github_deploy_key:
     github_url: "https://api.example.com"
     owner: "janedoe"
     repo: "example"

plugins/modules/source_control/github/github_hooks.py

@@ -60,17 +60,18 @@ author: "Phillip Gentry, CX Inc (@pcgentry)"
 '''
 
 EXAMPLES = '''
-# Example creating a new service hook. It ignores duplicates.
+- name: Create a new service hook ignoring duplicates
-- github_hooks:
+  github_hooks:
     action: create
     hookurl: http://11.111.111.111:2222
     user: '{{ gituser }}'
     oauthkey: '{{ oauthkey }}'
     repo: https://api.github.com/repos/pcgentry/Github-Auto-Deploy
 
-# Cleaning all hooks for this repo that had an error on the last update. Since this works for all hooks in a repo it is probably best that this would
+# Cleaning all hooks for this repo that had an error on the last update.
-# be called from a handler.
+# Since this works for all hooks in a repo it is probably best that this would be called from a handler.
-- github_hooks:
+- name: Clean all hooks
+  github_hooks:
     action: cleanall
     user: '{{ gituser }}'
     oauthkey: '{{ oauthkey }}'

plugins/modules/storage/hpe3par/ss_3par_cpg.py

@@ -92,31 +92,31 @@ extends_documentation_fragment:
 
 
 EXAMPLES = r'''
-    - name: Create CPG sample_cpg
+- name: Create CPG sample_cpg
-      ss_3par_cpg:
+  ss_3par_cpg:
-        storage_system_ip: 10.10.10.1
+    storage_system_ip: 10.10.10.1
-        storage_system_username: username
+    storage_system_username: username
-        storage_system_password: password
+    storage_system_password: password
-        state: present
+    state: present
-        cpg_name: sample_cpg
+    cpg_name: sample_cpg
-        domain: sample_domain
+    domain: sample_domain
-        growth_increment: 32000 MiB
+    growth_increment: 32000 MiB
-        growth_limit: 64000 MiB
+    growth_limit: 64000 MiB
-        growth_warning: 48000 MiB
+    growth_warning: 48000 MiB
-        raid_type: R6
+    raid_type: R6
-        set_size: 8
+    set_size: 8
-        high_availability: MAG
+    high_availability: MAG
-        disk_type: FC
+    disk_type: FC
-        secure: no
+    secure: no
 
-    - name: Delete CPG sample_cpg
+- name: Delete CPG sample_cpg
-      ss_3par_cpg:
+  ss_3par_cpg:
-        storage_system_ip: 10.10.10.1
+    storage_system_ip: 10.10.10.1
-        storage_system_username: username
+    storage_system_username: username
-        storage_system_password: password
+    storage_system_password: password
-        state: absent
+    state: absent
-        cpg_name: sample_cpg
+    cpg_name: sample_cpg
-        secure: no
+    secure: no
 '''
 
 RETURN = r'''

plugins/modules/system/openwrt_init.py

@@ -42,23 +42,23 @@ requirements:
 '''
 
 EXAMPLES = '''
-# Example action to start service httpd, if not running
+- name: Start service httpd, if not running
-- openwrt_init:
+  openwrt_init:
     state: started
     name: httpd
 
-# Example action to stop service cron, if running
+- name: Stop service cron, if running
-- openwrt_init:
+  openwrt_init:
     name: cron
     state: stopped
 
-# Example action to reload service httpd, in all cases
+- name: Reload service httpd, in all cases
-- openwrt_init:
+  openwrt_init:
     name: httpd
     state: reloaded
 
-# Example action to enable service httpd
+- name: Enable service httpd
-- openwrt_init:
+  openwrt_init:
     name: httpd
     enabled: yes
 '''

plugins/modules/system/osx_defaults.py

@@ -70,6 +70,8 @@ notes:
 '''
 
 EXAMPLES = r'''
+# TODO: Describe what happens in each example
+
 - osx_defaults:
     domain: com.apple.Safari
     key: IncludeInternalDebugMenu

plugins/modules/web_infrastructure/apache2_mod_proxy.py

@@ -54,38 +54,46 @@ options:
 '''
 
 EXAMPLES = '''
-# Get all current balancer pool members' attributes:
+- name: Get all current balancer pool members attributes
-- apache2_mod_proxy:
+  apache2_mod_proxy:
     balancer_vhost: 10.0.0.2
 
-# Get a specific member's attributes:
+- name: Get a specific member attributes
-- apache2_mod_proxy:
+  apache2_mod_proxy:
     balancer_vhost: myws.mydomain.org
     balancer_suffix: /lb/
     member_host: node1.myws.mydomain.org
 
 # Enable all balancer pool members:
-- apache2_mod_proxy:
+- name: Get attributes
+  apache2_mod_proxy:
     balancer_vhost: '{{ myloadbalancer_host }}'
   register: result
-- apache2_mod_proxy:
+
+- name: Enable all balancer pool members
+  apache2_mod_proxy:
     balancer_vhost: '{{ myloadbalancer_host }}'
     member_host: '{{ item.host }}'
     state: present
   with_items: '{{ result.members }}'
 
 # Gracefully disable a member from a loadbalancer node:
-- apache2_mod_proxy:
+- name: Step 1
+  apache2_mod_proxy:
     balancer_vhost: '{{ vhost_host }}'
     member_host: '{{ member.host }}'
     state: drained
   delegate_to: myloadbalancernode
-- wait_for:
+
+- name: Step 2
+  wait_for:
     host: '{{ member.host }}'
     port: '{{ member.port }}'
     state: drained
   delegate_to: myloadbalancernode
-- apache2_mod_proxy:
+
+- name: Step 3
+  apache2_mod_proxy:
     balancer_vhost: '{{ vhost_host }}'
     member_host: '{{ member.host }}'
     state: absent

plugins/modules/web_infrastructure/apache2_module.py

@@ -49,26 +49,30 @@ requirements: ["a2enmod","a2dismod"]
 '''
 
 EXAMPLES = '''
-# enables the Apache2 module "wsgi"
+- name: Enable the Apache2 module wsgi
-- apache2_module:
+  apache2_module:
     state: present
     name: wsgi
-# disables the Apache2 module "wsgi"
+
-- apache2_module:
+- name: Disables the Apache2 module wsgi
+  apache2_module:
     state: absent
     name: wsgi
-# disable default modules for Debian
+
-- apache2_module:
+- name: Disable default modules for Debian
+  apache2_module:
     state: absent
     name: autoindex
     force: True
-# disable mpm_worker and ignore warnings about missing mpm module
+
-- apache2_module:
+- name: Disable mpm_worker and ignore warnings about missing mpm module
+  apache2_module:
     state: absent
     name: mpm_worker
     ignore_configcheck: True
-# enable dump_io module, which is identified as dumpio_module inside apache2
+
-- apache2_module:
+- name: Enable dump_io module, which is identified as dumpio_module inside apache2
+  apache2_module:
     state: present
     name: dump_io
     identifier: dumpio_module

plugins/modules/web_infrastructure/django_manage.py

@@ -97,33 +97,33 @@ author: "Scott Anderson (@tastychutney)"
 '''
 
 EXAMPLES = """
-# Run cleanup on the application installed in 'django_dir'.
+- name: Run cleanup on the application installed in django_dir
-- django_manage:
+  django_manage:
     command: cleanup
     app_path: "{{ django_dir }}"
 
-# Load the initial_data fixture into the application
+- name: Load the initial_data fixture into the application
-- django_manage:
+  django_manage:
     command: loaddata
     app_path: "{{ django_dir }}"
     fixtures: "{{ initial_data }}"
 
-# Run syncdb on the application
+- name: Run syncdb on the application
-- django_manage:
+  django_manage:
     command: syncdb
     app_path: "{{ django_dir }}"
     settings: "{{ settings_app_name }}"
     pythonpath: "{{ settings_dir }}"
     virtualenv: "{{ virtualenv_dir }}"
 
-# Run the SmokeTest test case from the main app. Useful for testing deploys.
+- name: Run the SmokeTest test case from the main app. Useful for testing deploys
-- django_manage:
+  django_manage:
     command: test
     app_path: "{{ django_dir }}"
     apps: main.SmokeTest
 
-# Create an initial superuser.
+- name: Create an initial superuser
-- django_manage:
+  django_manage:
     command: "createsuperuser --noinput --username=admin --email=admin@example.com"
     app_path: "{{ django_dir }}"
 """

plugins/modules/web_infrastructure/htpasswd.py

@@ -63,8 +63,8 @@ extends_documentation_fragment: files
 '''
 
 EXAMPLES = """
-# Add a user to a password file and ensure permissions are set
+- name: Add a user to a password file and ensure permissions are set
-- htpasswd:
+  htpasswd:
     path: /etc/nginx/passwdfile
     name: janedoe
     password: '9s36?;fyNp'
@@ -72,14 +72,14 @@ EXAMPLES = """
     group: www-data
     mode: 0640
 
-# Remove a user from a password file
+- name: Remove a user from a password file
-- htpasswd:
+  htpasswd:
     path: /etc/apache2/passwdfile
     name: foobar
     state: absent
 
-# Add a user to a password file suitable for use by libpam-pwdfile
+- name: Add a user to a password file suitable for use by libpam-pwdfile
-- htpasswd:
+  htpasswd:
     path: /etc/mail/passwords
     name: alex
     password: oedu2eGh

plugins/modules/web_infrastructure/supervisorctl.py

@@ -55,32 +55,32 @@ author:
 '''
 
 EXAMPLES = '''
-# Manage the state of program to be in 'started' state.
+- name: Manage the state of program to be in started state
-- supervisorctl:
+  supervisorctl:
     name: my_app
     state: started
 
-# Manage the state of program group to be in 'started' state.
+- name: Manage the state of program group to be in started state
-- supervisorctl:
+  supervisorctl:
     name: 'my_apps:'
     state: started
 
-# Restart my_app, reading supervisorctl configuration from a specified file.
+- name: Restart my_app, reading supervisorctl configuration from a specified file
-- supervisorctl:
+  supervisorctl:
     name: my_app
     state: restarted
     config: /var/opt/my_project/supervisord.conf
 
-# Restart my_app, connecting to supervisord with credentials and server URL.
+- name: Restart my_app, connecting to supervisord with credentials and server URL
-- supervisorctl:
+  supervisorctl:
     name: my_app
     state: restarted
     username: test
     password: testpass
     server_url: http://localhost:9001
 
-# Send a signal to my_app via supervisorctl
+- name: Send a signal to my_app via supervisorctl
-- supervisorctl:
+  supervisorctl:
     name: my_app
     state: signalled
     signal: USR1

plugins/modules/web_infrastructure/taiga_issue.py

@@ -72,8 +72,8 @@ notes:
 '''
 
 EXAMPLES = '''
-# Create an issue in the my hosted Taiga environment and attach an error log
+- name: Create an issue in the my hosted Taiga environment and attach an error log
-- taiga_issue:
+  taiga_issue:
     taiga_host: https://mytaigahost.example.com
     project: myproject
     subject: An error has been found
@@ -89,8 +89,8 @@ EXAMPLES = '''
       - Needs manual check
     state: present
 
-# Deletes the previously created issue
+- name: Deletes the previously created issue
-- taiga_issue:
+  taiga_issue:
     taiga_host: https://mytaigahost.example.com
     project: myproject
     subject: An error has been found