Rev 1752: Docstring and copyright header update per Martin's review. in http://people.ubuntu.com/~robertc/baz2.0/readdir

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/readdir

------------------------------------------------------------
revno: 1752
revision-id: robertc at robertcollins.net-20080902044547-9s1i9d3mwemkfrsp
parent: robertc at robertcollins.net-20080902042042-kj0jzu2a4ndioa58
committer: Robert Collins <robertc at robertcollins.net>
branch nick: readdir
timestamp: Tue 2008-09-02 14:45:47 +1000
message:
  Docstring and copyright header update per Martin's review.
modified:
  bzrlib/_readdir_py.py          readdir.py-20060609152855-rm6v321vuaqyh9tu-3
  bzrlib/_readdir_pyx.pyx        readdir.pyx-20060609152855-rm6v321vuaqyh9tu-1
  bzrlib/readdir.h               readdir.h-20060609152855-rm6v321vuaqyh9tu-2
=== modified file 'bzrlib/_readdir_py.py'
--- a/bzrlib/_readdir_py.py	2008-08-20 03:30:17 +0000
+++ b/bzrlib/_readdir_py.py	2008-09-02 04:45:47 +0000
@@ -21,10 +21,11 @@
 
 
 def read_dir(path):
-    """Like os.listdir, this reads a directories contents.
+    """Like os.listdir, this reads the contents of a directory.
 
     There is a C module which is recommended which will return
-    a file kind in the second element of the returned tuples.
+    a sort key in the first element of the tuple to allow slightly
+    more efficient behaviour on the operating systems part.
 
     :param path: the directory to list.
     :return: a list of (None, basename) tuples.

=== modified file 'bzrlib/_readdir_pyx.pyx'
--- a/bzrlib/_readdir_pyx.pyx	2008-09-02 03:03:15 +0000
+++ b/bzrlib/_readdir_pyx.pyx	2008-09-02 04:45:47 +0000
@@ -69,7 +69,7 @@
     pass
 
 def read_dir(path):
-    """Like os.listdir, this reads a directories contents.
+    """Like os.listdir, this reads the contents of a directory.
 
     :param path: the directory to list.
     :return: a list of (sort_key, basename) tuples.

=== modified file 'bzrlib/readdir.h'
--- a/bzrlib/readdir.h	2006-06-09 15:34:26 +0000
+++ b/bzrlib/readdir.h	2008-09-02 04:45:47 +0000
@@ -1,5 +1,5 @@
 /*
- *  Bazaar-NG -- distributed version control
+ *  Bazaar -- distributed version control
  *
  * Copyright (C) 2006 by Canonical Ltd
  *