Documentation formatting for mongodb_user so it will show up in ansible-doc and the web.

This commit is contained in:
Michael DeHaan 2013-02-09 14:43:17 -05:00
parent c6e8b3a8e6
commit b22b087cf0

View file

@ -24,7 +24,7 @@ module: mongodb_user
short_description: Adds or removes a user from a MongoDB database.
description:
- Adds or removes a user from a MongoDB database.
version_added: "0.X"
version_added: "1.1"
options:
login_user:
description:
@ -41,7 +41,7 @@ options:
- The host running the database
required: false
default: localhost
login_port
login_port:
description:
- The port to connect to
required: false
@ -72,9 +72,9 @@ examples:
description: Create 'burgers' database user with name 'bob' and password '12345'.
- code: "mongodb_user: database=burgers name=bob state=absent"
description: Delete 'burgers' database user with name 'bob'.
notes:
- Requires the pymongo Python package on teh remote host, version 2.4.2+. This
can be installed using pip. @see http://api.mongodb.org/python/current/installation.html
notes:
- Requires the pymongo Python package on the remote host, version 2.4.2+. This
can be installed using pip or the OS package manager. @see http://api.mongodb.org/python/current/installation.html
requirements: [ "pymongo" ]
author: Elliott Foster
'''