Merge lp:~bialix/bzr/relpath-docstring into lp:bzr

[Alexander Belchenko]

Improve docstring of bzrlib.osutils.relpath

Trivial change based on the attempt to use that function.

[Andrew Bennetts (spiv)]

The meaning of "false negative result" wasn't clear to me. I had to experiment to be sure. How about saying "NOTE: `base` should not have a trailing slash otherwise you'll get PathNotChild exceptions regardless of `path`."?

Even better would be to fix that behaviour: that sounds very much like a bug to me. But in the meantime a clearer docstring is certainly an improvement.

review: Needs Fixing

[Alexander Belchenko (bialix)]

Changed as you suggested.

[Parth Malwankar (parthm)]

Looks good to me.

review: Approve

[Andrew Bennetts (spiv)]

review: Approve

[bzr PQM (bzr-pqm)]

Successful steps
Failure output:
All lines of log output:
Executing star-merge http://bazaar.launchpad.net/~bialix/bzr/relpath-docstring at Mon May 3 07:26:17 2010
['Nothing to merge.']

=== modified file 'bzrlib/osutils.py'
--- bzrlib/osutils.py	2010-04-27 07:52:08 +0000
+++ bzrlib/osutils.py	2010-04-30 07:03:34 +0000
@@ -1149,7 +1149,7 @@
 
 
 def relpath(base, path):
-    """Return path relative to base, or raise exception.
+    """Return path relative to base, or raise PathNotChild exception.
 
     The path may be either an absolute path or a path relative to the
     current working directory.
@@ -1157,6 +1157,9 @@
     os.path.commonprefix (python2.4) has a bad bug that it works just
     on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
     avoids that problem.
+
+    NOTE: `base` should not have a trailing slash otherwise you'll get
+    PathNotChild exceptions regardless of `path`.
     """
 
     if len(base) < MIN_ABS_PATHLENGTH: