~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/pyutils.py

Docstring tweaks prompted by review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Some convenience functions for general Python, such as a wrapper around
18
 
``_import__``.
19
 
"""
 
18
``_import__``."""
20
19
 
21
20
 
22
21
import sys
32
31
        >>> doc.splitlines()[0]
33
32
        'Get the Python object named by a given module and member name.'
34
33
 
35
 
    :param module_name: a module name, as found in sys.module.  It may contain
36
 
        dots.  e.g. 'sys' or 'os.path'.
 
34
    :param module_name: a module name, as would be found in sys.modules if
 
35
        the module is already imported.  It may contain dots.  e.g. 'sys' or
 
36
        'os.path'.
37
37
    :param member_name: (optional) a name of an attribute in that module to
38
38
        return.  It may contain dots.  e.g. 'MyClass.some_method'.  If not
39
39
        given, the named module will be returned instead.