Merge lp:~vila/bzr/cleanup into lp:bzr

[Vincent Ladeuil]

Docstrings cleanup.

A couple of fixes accumulated over time, mostly docstrings, nothing that should be controversial ;)

[Richard Wilbur (richard-wilbur)]

Thanks Vincent for giving some love to the docstrings and good catch on the new builtin function.
+1

review: Approve

[Vincent Ladeuil (vila)]

sent to pqm by email

=== modified file 'bzrlib/config.py'
--- bzrlib/config.py	2012-09-19 09:15:29 +0000
+++ bzrlib/config.py	2013-08-09 15:16:06 +0000
@@ -2316,8 +2316,7 @@
         :param help: a doc string to explain the option to the user.
 
         :param from_unicode: a callable to convert the unicode string
-            representing the option value in a store. This is not called for
-            the default value.
+            representing the option value in a store or its default value.
 
         :param invalid: the action to be taken when an invalid value is
             encountered in a store. This is called only when from_unicode is
@@ -3400,9 +3399,9 @@
 
 
 class LocationStore(LockableIniFileStore):
-    """A config store for global options.
+    """A config store for options specific to a location.
 
-    There is a single GlobalStore for a given process.
+    There is a single LocationStore for a given process.
     """
 
     def __init__(self, possible_transports=None):

=== modified file 'bzrlib/filters/__init__.py'
--- bzrlib/filters/__init__.py	2012-08-02 11:28:25 +0000
+++ bzrlib/filters/__init__.py	2013-08-09 15:16:06 +0000
@@ -18,7 +18,7 @@
 
 A filter consists of a read converter, write converter pair.
 The content in the working tree is called the convenience format
-while the content actually stored in called the canonical format.
+while the content actually stored is called the canonical format.
 The read converter produces canonical content from convenience
 content while the writer goes the other way.
 

=== modified file 'bzrlib/tests/__init__.py'
--- bzrlib/tests/__init__.py	2013-06-24 12:03:12 +0000
+++ bzrlib/tests/__init__.py	2013-08-09 15:16:06 +0000
@@ -3792,7 +3792,7 @@
 
     :return: (absents, duplicates) absents is a list containing the test found
         in id_list but not in test_suite, duplicates is a list containing the
-        test found multiple times in test_suite.
+        tests found multiple times in test_suite.
 
     When using a prefined test id list, it may occurs that some tests do not
     exist anymore or that some tests use the same id. This function warns the
@@ -4341,7 +4341,7 @@
     """Copy test and apply scenario to it.
 
     :param test: A test to adapt.
-    :param scenario: A tuple describing the scenarion.
+    :param scenario: A tuple describing the scenario.
         The first element of the tuple is the new test id.
         The second element is a dict containing attributes to set on the
         test.

=== modified file 'bzrlib/transport/http/response.py'
--- bzrlib/transport/http/response.py	2013-05-24 23:45:55 +0000
+++ bzrlib/transport/http/response.py	2013-08-09 15:16:06 +0000
@@ -289,15 +289,15 @@
                     % (size, self._start, self._size))
 
         # read data from file
-        buffer = StringIO()
+        buf = StringIO()
         limited = size
         if self._size > 0:
             # Don't read past the range definition
             limited = self._start + self._size - self._pos
             if size >= 0:
                 limited = min(limited, size)
-        osutils.pumpfile(self._file, buffer, limited, self._max_read_size)
-        data = buffer.getvalue()
+        osutils.pumpfile(self._file, buf, limited, self._max_read_size)
+        data = buf.getvalue()
 
         # Update _pos respecting the data effectively read
         self._pos += len(data)