aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRonan Amicel <ronan.amicel@gmail.com>2012-10-12 12:11:57 +0200
committerRonan Amicel <ronan.amicel@gmail.com>2012-10-13 12:22:37 +0200
commit8e4917c20a5649a8a941ab9b70f2a966c9bb7703 (patch)
treefce3cb482f2c09dbd9f93657d1281b958bc0bd5e
parentMerge pull request #38 from laurentb/master (diff)
downloadfabtools-8e4917c20a5649a8a941ab9b70f2a966c9bb7703.tar.xz
Tweak documentation
-rw-r--r--fabtools/require/files.py4
-rw-r--r--fabtools/require/supervisor.py10
-rw-r--r--fabtools/require/users.py4
3 files changed, 9 insertions, 9 deletions
diff --git a/fabtools/require/files.py b/fabtools/require/files.py
index 637c529..bf0aefb 100644
--- a/fabtools/require/files.py
+++ b/fabtools/require/files.py
@@ -30,7 +30,7 @@ def directory(path, use_sudo=False, owner='', group='', mode=''):
require.directory('/tmp/mydir', owner='alice')
- .. note:: this function can be accessed directly from the
+ .. note:: This function can be accessed directly from the
``fabtools.require`` module for convenience.
"""
@@ -76,7 +76,7 @@ def file(path=None, contents=None, source=None, url=None, md5=None,
same if it is present. This is useful for very large files, where
generating an MD5 sum may take a while.
- .. note:: this function can be accessed directly from the
+ .. note:: This function can be accessed directly from the
``fabtools.require`` module for convenience.
"""
diff --git a/fabtools/require/supervisor.py b/fabtools/require/supervisor.py
index fc1bb91..b934938 100644
--- a/fabtools/require/supervisor.py
+++ b/fabtools/require/supervisor.py
@@ -3,9 +3,9 @@ Supervisor processes
====================
This module provides high-level tools for managing long-running
-processes using `supervisord`_.
+processes using `supervisor`_.
-.. _supervisord: http://supervisord.org/
+.. _supervisor: http://supervisord.org/
"""
from __future__ import with_statement
@@ -26,11 +26,11 @@ def process(name, **kwargs):
- ``user``: run the process as this user
- ``stdout_logfile``: absolute path to the log file
- You should refer to the `supervisord documentation`_ for the
+ You should refer to the `supervisor documentation`_ for the
complete list of allowed arguments.
.. note:: the default values for the following arguments differs from
- the supervisord defaults:
+ the ``supervisor`` defaults:
- ``autorestart``: defaults to ``true``
- ``redirect_stderr``: defaults to ``true``
@@ -46,7 +46,7 @@ def process(name, **kwargs):
stdout_logfile='/path/to/logs/myapp.log',
)
- .. _supervisord documentation: http://supervisord.org/configuration.html#program-x-section-values
+ .. _supervisor documentation: http://supervisord.org/configuration.html#program-x-section-values
"""
from fabtools import require
require.deb.package('supervisor')
diff --git a/fabtools/require/users.py b/fabtools/require/users.py
index 6e1157c..4e5e6d8 100644
--- a/fabtools/require/users.py
+++ b/fabtools/require/users.py
@@ -19,7 +19,7 @@ def user(name, home=None):
require.user('alice') # no home directory
require.user('bob', home='/home/bob')
- .. note:: this function can be accessed directly from the
+ .. note:: This function can be accessed directly from the
``fabtools.require`` module for convenience.
"""
@@ -33,7 +33,7 @@ def sudoer(username, hosts="ALL", operators="ALL", passwd=False, commands="ALL")
"""
Require sudo permissions for a given user.
- .. note:: this function can be accessed directly from the
+ .. note:: This function can be accessed directly from the
``fabtools.require`` module for convenience.
"""