Many more doc fixes

10 years ago · 4f07e8b256
parent ec68f78556
commit 4f07e8b256
23 changed files with 34 additions and 24 deletions
--- a/lib/ansible/modules/extras/cloud/misc/virt.py
+++ b/lib/ansible/modules/extras/cloud/misc/virt.py
@ -58,10 +58,10 @@ options:
 requirements:
    - "python >= 2.6"
    - "libvirt-python"
-author: 
+author:
    - "Ansible Core Team"
-    - "Michael DeHaan (@mpdehaan)" <michael.dehaan@gmail.com>
-    - "Seth Vidal (@skvidal)" <skvidal@fedoraproject.org>
+    - '"Michael DeHaan (@mpdehaan)" <michael.dehaan@gmail.com>'
+    - '"Seth Vidal (@skvidal)" <skvidal@fedoraproject.org>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/cloud/vmware/vmware_datacenter.py
+++ b/lib/ansible/modules/extras/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
+author: '"Joseph Callen (@jcpowermac)" <jcallen () csc.com>'
 notes:
    - Tested on vSphere 5.5
 requirements:
--- a/lib/ansible/modules/extras/database/misc/riak.py
+++ b/lib/ansible/modules/extras/database/misc/riak.py
@ -26,6 +26,9 @@ description:
     - This module can be used to join nodes to a cluster, check
       the status of the cluster.
 version_added: "1.2"
+author:
+    - '"James Martin (@jsmartin)" <jmartin@ansible.com>'
+    - '"Drew Kerrigan (@drewkerrigan)" <dkerrigan@basho.com>'
 options:
  command:
    description:
--- a/lib/ansible/modules/extras/monitoring/rollbar_deployment.py
+++ b/lib/ansible/modules/extras/monitoring/rollbar_deployment.py
@ -22,7 +22,7 @@ DOCUMENTATION = '''
 ---
 module: rollbar_deployment
 version_added: 1.6
-author: Max Riveiro
+author: '"Max Riveiro (@kavu)" <kavu13@gmail.com>'
 short_description: Notify Rollbar about app deployments
 description:
  - Notify Rollbar about app deployments
--- a/lib/ansible/modules/extras/monitoring/zabbix_group.py
+++ b/lib/ansible/modules/extras/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
+author: '"René Moser (@resmo)" <mail@renemoser.net>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/notification/pushover.py
+++ b/lib/ansible/modules/extras/notification/pushover.py
@ -48,7 +48,7 @@ options:
    description: Message priority (see u(https://pushover.net) for details.)
    required: false

-author: Jim Richardson
+author: '"Jim Richardson (@weaselkeeper)" <weaselkeeper@gmail.com>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/notification/sendgrid.py
+++ b/lib/ansible/modules/extras/notification/sendgrid.py
@ -53,7 +53,7 @@ options:
      the desired subject for the email
    required: true

-author: Matt Makai
+author: '"Matt Makai (@makaimc)" <matthew.makai@gmail.com>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/notification/slack.py
+++ b/lib/ansible/modules/extras/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 <ramon@delafuente.nl>
+author: '"Ramon de la Fuente (@ramondelafuente)" <ramon@delafuente.nl>'
 options:
  domain:
    description:
--- a/lib/ansible/modules/extras/notification/sns.py
+++ b/lib/ansible/modules/extras/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@gmail.com>
+author: '"Michael J. Schultz (@mjschultz)" <mjschultz@gmail.com>'
 options:
  msg:
    description:
--- a/lib/ansible/modules/extras/notification/twilio.py
+++ b/lib/ansible/modules/extras/notification/twilio.py
@ -58,7 +58,7 @@ options:
      (multimedia message) instead of a plain SMS
    required: false

-author: Matt Makai
+author: '"Matt Makai (@makaimc)" <matthew.makai@gmail.com>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/notification/typetalk.py
+++ b/lib/ansible/modules/extras/notification/typetalk.py
@ -26,7 +26,7 @@ options:
      - message body
    required: true
 requirements: [ urllib, urllib2, json ]
-author: Takashi Someda <someda@isenshi.com>
+author: '"Takashi Someda (@tksmd)" <someda@isenshi.com>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/packaging/os/pkg5.py
+++ b/lib/ansible/modules/extras/packaging/os/pkg5.py
@ -19,7 +19,7 @@
 DOCUMENTATION = '''
 ---
 module: pkg5
-author: Peter Oliver
+author: '"Peter Oliver (@mavit)" <ansible@mavit.org.uk>'
 short_description: Manages packages with the Solaris 11 Image Packaging System
 description:
  - IPS packages are the native packages in Solaris 11 and higher.
--- a/lib/ansible/modules/extras/packaging/os/pkg5_publisher.py
+++ b/lib/ansible/modules/extras/packaging/os/pkg5_publisher.py
@ -19,7 +19,7 @@
 DOCUMENTATION = '''
 ---
 module: pkg5_publisher
-author: Peter Oliver
+author: '"Peter Oliver (@mavit)" <ansible@mavit.org.uk>'
 short_description: Manages Solaris 11 Image Packaging System publishers
 description:
  - IPS packages are the native packages in Solaris 11 and higher.
--- a/lib/ansible/modules/extras/packaging/os/pkgin.py
+++ b/lib/ansible/modules/extras/packaging/os/pkgin.py
@ -30,7 +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: Shaun Zinck, Larry Gilbert
+author:
+    - '"Larry Gilbert (L2G)" <larry@L2G.to>'
+    - '"Shaun Zinck (@szinck)" <shaun.zinck at gmail.com>'
 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
--- a/lib/ansible/modules/extras/packaging/os/pkgng.py
+++ b/lib/ansible/modules/extras/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
+author: '"bleader (@bleader)" <bleader@ratonland.org>'
 notes:
    - When using pkgsite, be careful that already in cache packages won't be downloaded again.
 '''
--- a/lib/ansible/modules/extras/packaging/os/pkgutil.py
+++ b/lib/ansible/modules/extras/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
+author: '"Alexander Winkler (@dermute)" <mail () winkler-alexander.de>'
 options:
  name:
    description:
--- a/lib/ansible/modules/extras/packaging/os/portinstall.py
+++ b/lib/ansible/modules/extras/packaging/os/portinstall.py
@ -43,7 +43,7 @@ options:
        choices: [ 'yes', 'no' ]
        required: false
        default: yes
-author: berenddeboer
+author: '"berenddeboer (@berenddeboer)" <berend@pobox.com>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/packaging/os/swdepot.py
+++ b/lib/ansible/modules/extras/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
+author: '"Raul Melo (@melodous)" <raulmelo@gmail.com>'
 options:
    name:
        description:
--- a/lib/ansible/modules/extras/packaging/os/urpmi.py
+++ b/lib/ansible/modules/extras/packaging/os/urpmi.py
@ -57,7 +57,7 @@ options:
    required: false
    default: yes
    choices: [ "yes", "no" ]
-author: Philippe Makowski
+author: '"Philippe Makowski (@pmakowski)" <philippem@mageia.org>'
 notes:  []
 '''

--- a/lib/ansible/modules/extras/system/ufw.py
+++ b/lib/ansible/modules/extras/system/ufw.py
@ -28,7 +28,10 @@ short_description: Manage firewall with UFW
 description:
    - Manage firewall with UFW.
 version_added: 1.6
-author: Aleksey Ovcharenko, Jarno Keskikangas, Ahti Kitsik
+author:
+    - '"Aleksey Ovcharenko (@ovcharenko)" <aleksey.ovcharenko@gmail.com>'
+    - '"Jarno Keskikangas (@pyykkis)" <jarno.keskikangas@gmail.com>'
+    - '"Ahti Kitsik (@ahtik)" <ak@ahtik.com>'
 notes:
    - See C(man ufw) for more examples.
 requirements:
--- a/lib/ansible/modules/extras/system/zfs.py
+++ b/lib/ansible/modules/extras/system/zfs.py
@ -206,7 +206,7 @@ options:
      - The zoned property.
    required: False
    choices: ['on','off']
-author: Johan Wiren
+author: '"Johan Wiren (@johanwiren)" <johan.wiren.se@gmail.com>'
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/extras/windows/win_chocolatey.py
+++ b/lib/ansible/modules/extras/windows/win_chocolatey.py
@ -86,7 +86,9 @@ options:
    require: false
    default: c:\\ansible-playbook.log
    aliases: []
-author: Trond Hindenes, Peter Mounce
+author:
+    - '"Trond Hindenes (@trondhindenes)" <trond@hindenes.com>'
+    - '"Peter Mounce (@petemounce)" <public@neverrunwithscissors.com>'
 '''

 # TODO:
--- a/lib/ansible/modules/extras/windows/win_updates.py
+++ b/lib/ansible/modules/extras/windows/win_updates.py
@ -41,7 +41,7 @@ options:
      - (anything that is a valid update category)
    default: critical
    aliases: []
-author: Peter Mounce
+author: '"Peter Mounce (@petemounce)" <public@neverrunwithscissors.com>'
 '''

 EXAMPLES = '''