Merge pull request #1751 from javiromero/docstrings

Uppercase first word in docstrings. Change to an imperative form.

Author: nicoddemus

AUTHORS

@@ -96,3 +96,4 @@ Tom Viner
 Trevor Bekolay
 Wouter van Ackooy
 Bernard Pratz
+Javier Romero

CHANGELOG.rst

@@ -36,12 +36,14 @@
   Thanks `@bagerard`_ for reporting (`#1503`_). Thanks to `@davehunt`_ and
   `@tomviner`_ for PR.
 
-* Renamed the pytest ``pdb`` module (plugin) into ``debugging``. 
+* Renamed the pytest ``pdb`` module (plugin) into ``debugging``.
 
 * Improve of the test output for logical expression with brackets.
   Fixes(`#925`_). Thanks `@DRMacIver`_ for reporting. Thanks to `@RedBeardCode`_
   for PR.
 
+* Updated docstrings with a more uniform style.
+
 *
 
 * ImportErrors in plugins now are a fatal error instead of issuing a

_pytest/capture.py

@@ -156,7 +156,7 @@ def suspendcapture_item(self, item, when):
 
 @pytest.fixture
 def capsys(request):
-    """enables capturing of writes to sys.stdout/sys.stderr and makes
+    """Enable capturing of writes to sys.stdout/sys.stderr and make
     captured output available via ``capsys.readouterr()`` method calls
     which return a ``(out, err)`` tuple.
     """
@@ -167,7 +167,7 @@ def capsys(request):
 
 @pytest.fixture
 def capfd(request):
-    """enables capturing of writes to file descriptors 1 and 2 and makes
+    """Enable capturing of writes to file descriptors 1 and 2 and make
     captured output available via ``capfd.readouterr()`` method calls
     which return a ``(out, err)`` tuple.
     """

_pytest/junitxml.py

@@ -186,8 +186,8 @@ def finalize(self):
 
 @pytest.fixture
 def record_xml_property(request):
-    """Fixture that adds extra xml properties to the tag for the calling test.
-    The fixture is callable with (name, value), with value being automatically
+    """Add extra xml properties to the tag for the calling test.
+    The fixture is callable with ``(name, value)``, with value being automatically
     xml-encoded.
     """
     request.node.warn(

_pytest/monkeypatch.py

@@ -9,7 +9,7 @@
 
 
 def pytest_funcarg__monkeypatch(request):
-    """The returned ``monkeypatch`` funcarg provides these
+    """Return a ``monkeypatch`` funcarg providing the following
     helper methods to modify objects, dictionaries or os.environ::
 
         monkeypatch.setattr(obj, name, value, raising=True)
@@ -220,10 +220,10 @@ def undo(self):
         """ Undo previous changes.  This call consumes the
         undo stack. Calling it a second time has no effect unless
         you do more monkeypatching after the undo call.
-        
+
         There is generally no need to call `undo()`, since it is
         called automatically during tear-down.
-        
+
         Note that the same `monkeypatch` fixture is used across a
         single test function invocation. If `monkeypatch` is used both by
         the test function itself and one of the test fixtures,

_pytest/python.py

@@ -271,7 +271,7 @@ def pytest_namespace():
 
 @fixture(scope="session")
 def pytestconfig(request):
-    """ the pytest config object with access to command line opts."""
+    """ The pytest config object with access to command line opts."""
     return request.config
 
 

_pytest/tmpdir.py

@@ -108,7 +108,7 @@ def tmpdir_factory(request):
 
 @pytest.fixture
 def tmpdir(request, tmpdir_factory):
-    """return a temporary directory path object
+    """Return a temporary directory path object
     which is unique to each test function invocation,
     created as a sub directory of the base temporary
     directory.  The returned object is a `py.path.local`_