From 88eff11c048f88ed9a49bf1f38a26493083d35a2 Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Fri, 15 May 2015 12:12:26 -0700 Subject: [PATCH] Many more doc fixes --- cloud/misc/virt.py | 6 +++--- cloud/vmware/vmware_datacenter.py | 2 +- database/misc/riak.py | 4 ++-- monitoring/rollbar_deployment.py | 2 +- monitoring/zabbix_group.py | 2 +- notification/pushover.py | 2 +- notification/sendgrid.py | 2 +- notification/slack.py | 2 +- notification/sns.py | 2 +- notification/twilio.py | 2 +- notification/typetalk.py | 2 +- packaging/os/pkg5.py | 2 +- packaging/os/pkg5_publisher.py | 2 +- packaging/os/pkgin.py | 6 +++--- packaging/os/pkgng.py | 2 +- packaging/os/pkgutil.py | 2 +- packaging/os/portinstall.py | 2 +- packaging/os/swdepot.py | 2 +- packaging/os/urpmi.py | 2 +- system/ufw.py | 8 ++++---- system/zfs.py | 2 +- windows/win_chocolatey.py | 6 +++--- windows/win_updates.py | 2 +- 23 files changed, 33 insertions(+), 33 deletions(-) diff --git a/cloud/misc/virt.py b/cloud/misc/virt.py index 540dddc3ba4..343a3eedcf7 100644 --- a/cloud/misc/virt.py +++ b/cloud/misc/virt.py @@ -58,10 +58,10 @@ options: requirements: - "python >= 2.6" - "libvirt-python" -author: +author: - "Ansible Core Team" - - "Michael DeHaan (@mpdehaan)" - - "Seth Vidal (@skvidal)" + - '"Michael DeHaan (@mpdehaan)" ' + - '"Seth Vidal (@skvidal)" ' ''' EXAMPLES = ''' diff --git a/cloud/vmware/vmware_datacenter.py b/cloud/vmware/vmware_datacenter.py index b9101fc2626..b1e995b965b 100644 --- a/cloud/vmware/vmware_datacenter.py +++ b/cloud/vmware/vmware_datacenter.py @@ -25,7 +25,7 @@ short_description: Manage VMware vSphere Datacenters description: - Manage VMware vSphere Datacenters version_added: 2.0 -author: "Joseph Callen (@jcpowermac)" +author: '"Joseph Callen (@jcpowermac)" ' notes: - Tested on vSphere 5.5 requirements: diff --git a/database/misc/riak.py b/database/misc/riak.py index f6c0d64ee42..4f10775a5ad 100644 --- a/database/misc/riak.py +++ b/database/misc/riak.py @@ -27,8 +27,8 @@ description: the status of the cluster. version_added: "1.2" author: - - "James Martin (@jsmartin)" - - "Drew Kerrigan (@drewkerrigan)" + - '"James Martin (@jsmartin)" ' + - '"Drew Kerrigan (@drewkerrigan)" ' options: command: description: diff --git a/monitoring/rollbar_deployment.py b/monitoring/rollbar_deployment.py index 5a643697e5b..dc064d6194d 100644 --- a/monitoring/rollbar_deployment.py +++ b/monitoring/rollbar_deployment.py @@ -22,7 +22,7 @@ DOCUMENTATION = ''' --- module: rollbar_deployment version_added: 1.6 -author: "Max Riveiro (@kavu)" +author: '"Max Riveiro (@kavu)" ' short_description: Notify Rollbar about app deployments description: - Notify Rollbar about app deployments diff --git a/monitoring/zabbix_group.py b/monitoring/zabbix_group.py index 73aa9400a6d..f622de5a4f7 100644 --- a/monitoring/zabbix_group.py +++ b/monitoring/zabbix_group.py @@ -64,7 +64,7 @@ options: required: true notes: - The module has been tested with Zabbix Server 2.2. -author: "René Moser (@resmo)" +author: '"René Moser (@resmo)" ' ''' EXAMPLES = ''' diff --git a/notification/pushover.py b/notification/pushover.py index c4d1333e36c..951c65f43fe 100644 --- a/notification/pushover.py +++ b/notification/pushover.py @@ -48,7 +48,7 @@ options: description: Message priority (see u(https://pushover.net) for details.) required: false -author: "Jim Richardson (@weaselkeeper)" +author: '"Jim Richardson (@weaselkeeper)" ' ''' EXAMPLES = ''' diff --git a/notification/sendgrid.py b/notification/sendgrid.py index 4893fea7fe3..6278f613ee4 100644 --- a/notification/sendgrid.py +++ b/notification/sendgrid.py @@ -53,7 +53,7 @@ options: the desired subject for the email required: true -author: "Matt Makai (@makaimc)" +author: '"Matt Makai (@makaimc)" ' ''' EXAMPLES = ''' diff --git a/notification/slack.py b/notification/slack.py index 61d01c7d443..7e5215479ab 100644 --- a/notification/slack.py +++ b/notification/slack.py @@ -24,7 +24,7 @@ short_description: Send Slack notifications description: - The M(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration version_added: 1.6 -author: "Ramon de la Fuente (@ramondelafuente)" +author: '"Ramon de la Fuente (@ramondelafuente)" ' options: domain: description: diff --git a/notification/sns.py b/notification/sns.py index 16b02e66486..910105f0ebb 100644 --- a/notification/sns.py +++ b/notification/sns.py @@ -24,7 +24,7 @@ short_description: Send Amazon Simple Notification Service (SNS) messages description: - The M(sns) module sends notifications to a topic on your Amazon SNS account version_added: 1.6 -author: "Michael J. Schultz (@mjschultz)" +author: '"Michael J. Schultz (@mjschultz)" ' options: msg: description: diff --git a/notification/twilio.py b/notification/twilio.py index 44366158ee1..568d0c60a58 100644 --- a/notification/twilio.py +++ b/notification/twilio.py @@ -58,7 +58,7 @@ options: (multimedia message) instead of a plain SMS required: false -author: "Matt Makai (@makaimc)" +author: '"Matt Makai (@makaimc)" ' ''' EXAMPLES = ''' diff --git a/notification/typetalk.py b/notification/typetalk.py index 1afd8d47045..8e79a7617ed 100644 --- a/notification/typetalk.py +++ b/notification/typetalk.py @@ -26,7 +26,7 @@ options: - message body required: true requirements: [ urllib, urllib2, json ] -author: "Takashi Someda (@tksmd)" +author: '"Takashi Someda (@tksmd)" ' ''' EXAMPLES = ''' diff --git a/packaging/os/pkg5.py b/packaging/os/pkg5.py index be0e24214ea..632a36796dc 100644 --- a/packaging/os/pkg5.py +++ b/packaging/os/pkg5.py @@ -19,7 +19,7 @@ DOCUMENTATION = ''' --- module: pkg5 -author: "Peter Oliver (@mavit)" +author: '"Peter Oliver (@mavit)" ' short_description: Manages packages with the Solaris 11 Image Packaging System version_added: 1.9 description: diff --git a/packaging/os/pkg5_publisher.py b/packaging/os/pkg5_publisher.py index 43d00ce4b25..1db07d512b7 100644 --- a/packaging/os/pkg5_publisher.py +++ b/packaging/os/pkg5_publisher.py @@ -19,7 +19,7 @@ DOCUMENTATION = ''' --- module: pkg5_publisher -author: "Peter Oliver (@mavit)" +author: '"Peter Oliver (@mavit)" ' short_description: Manages Solaris 11 Image Packaging System publishers version_added: 1.9 description: diff --git a/packaging/os/pkgin.py b/packaging/os/pkgin.py index e1a973c2d30..33bcb5482f0 100644 --- a/packaging/os/pkgin.py +++ b/packaging/os/pkgin.py @@ -30,9 +30,9 @@ description: - "The standard package manager for SmartOS, but also usable on NetBSD or any OS that uses C(pkgsrc). (Home: U(http://pkgin.net/))" version_added: "1.0" -author: - - "Larry Gilbert (L2G)" - - "Shaun Zinck (@szinck)" +author: + - '"Larry Gilbert (L2G)" ' + - '"Shaun Zinck (@szinck)" ' notes: - "Known bug with pkgin < 0.8.0: if a package is removed and another package depends on it, the other package will be silently removed as diff --git a/packaging/os/pkgng.py b/packaging/os/pkgng.py index 91ee0743e10..132cff637e6 100644 --- a/packaging/os/pkgng.py +++ b/packaging/os/pkgng.py @@ -63,7 +63,7 @@ options: for newer pkgng versions, specify a the name of a repository configured in /usr/local/etc/pkg/repos required: false -author: "bleader (@bleader)" +author: '"bleader (@bleader)" ' notes: - When using pkgsite, be careful that already in cache packages won't be downloaded again. ''' diff --git a/packaging/os/pkgutil.py b/packaging/os/pkgutil.py index a735b6d9ed0..62107aa0475 100644 --- a/packaging/os/pkgutil.py +++ b/packaging/os/pkgutil.py @@ -32,7 +32,7 @@ description: - Pkgutil is an advanced packaging system, which resolves dependency on installation. It is designed for CSW packages. version_added: "1.3" -author: "Alexander Winkler (@dermute)" +author: '"Alexander Winkler (@dermute)" ' options: name: description: diff --git a/packaging/os/portinstall.py b/packaging/os/portinstall.py index 3c9d75767fd..1673c4dde37 100644 --- a/packaging/os/portinstall.py +++ b/packaging/os/portinstall.py @@ -43,7 +43,7 @@ options: choices: [ 'yes', 'no' ] required: false default: yes -author: "berenddeboer (@berenddeboer)" +author: '"berenddeboer (@berenddeboer)" ' ''' EXAMPLES = ''' diff --git a/packaging/os/swdepot.py b/packaging/os/swdepot.py index 74c886ca75d..56b33d401bf 100644 --- a/packaging/os/swdepot.py +++ b/packaging/os/swdepot.py @@ -29,7 +29,7 @@ description: - Will install, upgrade and remove packages with swdepot package manager (HP-UX) version_added: "1.4" notes: [] -author: "Raul Melo (@melodous)" +author: '"Raul Melo (@melodous)" ' options: name: description: diff --git a/packaging/os/urpmi.py b/packaging/os/urpmi.py index 63fe6c7f8ef..c202ee27ace 100644 --- a/packaging/os/urpmi.py +++ b/packaging/os/urpmi.py @@ -57,7 +57,7 @@ options: required: false default: yes choices: [ "yes", "no" ] -author: "Philippe Makowski (@pmakowski)" +author: '"Philippe Makowski (@pmakowski)" ' notes: [] ''' diff --git a/system/ufw.py b/system/ufw.py index f9c1f3b57e9..3694f2b937a 100644 --- a/system/ufw.py +++ b/system/ufw.py @@ -28,10 +28,10 @@ short_description: Manage firewall with UFW description: - Manage firewall with UFW. version_added: 1.6 -author: - - "Aleksey Ovcharenko (@ovcharenko)" - - "Jarno Keskikangas (@pyykkis)" - - "Ahti Kitsik (@ahtik)" +author: + - '"Aleksey Ovcharenko (@ovcharenko)" ' + - '"Jarno Keskikangas (@pyykkis)" ' + - '"Ahti Kitsik (@ahtik)" ' notes: - See C(man ufw) for more examples. requirements: diff --git a/system/zfs.py b/system/zfs.py index 7a5cc205225..fed17b4a18d 100644 --- a/system/zfs.py +++ b/system/zfs.py @@ -206,7 +206,7 @@ options: - The zoned property. required: False choices: ['on','off'] -author: "Johan Wiren (@johanwiren)" +author: '"Johan Wiren (@johanwiren)" ' ''' EXAMPLES = ''' diff --git a/windows/win_chocolatey.py b/windows/win_chocolatey.py index ad0389aa398..63ec1ecd214 100644 --- a/windows/win_chocolatey.py +++ b/windows/win_chocolatey.py @@ -86,9 +86,9 @@ options: require: false default: c:\\ansible-playbook.log aliases: [] -author: - - "Trond Hindenes (@trondhindenes)" - - "Peter Mounce (@petemounce)" +author: + - '"Trond Hindenes (@trondhindenes)" ' + - '"Peter Mounce (@petemounce)" ' ''' # TODO: diff --git a/windows/win_updates.py b/windows/win_updates.py index 49d2eac3a2e..7c93109efb9 100644 --- a/windows/win_updates.py +++ b/windows/win_updates.py @@ -41,7 +41,7 @@ options: - (anything that is a valid update category) default: critical aliases: [] -author: "Peter Mounce (@petemounce)" +author: '"Peter Mounce (@petemounce)" ' ''' EXAMPLES = '''