Rev 5355: Add docstring. in file:///home/vila/src/bzr/bugs/525571-lock-bazaar-conf-files/

[Vincent Ladeuil]

At file:///home/vila/src/bzr/bugs/525571-lock-bazaar-conf-files/

------------------------------------------------------------
revno: 5355
revision-id: v.ladeuil+lp at free.fr-20100719130901-q9k48kax49whipkk
parent: v.ladeuil+lp at free.fr-20100719125454-0p46seg0nee5r0fg
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: simplify-test-config-building
timestamp: Mon 2010-07-19 15:09:01 +0200
message:
  Add docstring.
-------------- next part --------------
=== modified file 'bzrlib/config.py'
--- a/bzrlib/config.py	2010-07-19 09:31:44 +0000
+++ b/bzrlib/config.py	2010-07-19 13:09:01 +0000
@@ -354,6 +354,13 @@
 
     def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
                  file_name=None, _content=None):
+        """Base class for configuration files using an ini-like syntax.
+
+        :param file_name: The configuration file path.
+
+        :param _content: For tests only, a string representing the file
+            content. This will be utf-8 encoded.
+        """
         super(IniBasedConfig, self).__init__()
         if symbol_versioning.deprecated_passed(get_filename):
             symbol_versioning.warn(