From c5e0d3b432f1ccd0e45360a6f1b55d36160e969f Mon Sep 17 00:00:00 2001 From: mhagger Date: Sun, 19 Sep 2010 05:15:01 +0000 Subject: [PATCH] Improve docstrings for the "basename" members of the CVSPath classes. git-svn-id: http://cvs2svn.tigris.org/svn/cvs2svn/trunk@5275 be7e6eca-30d4-0310-a8e5-ac0d63af7087 --- cvs2svn_lib/cvs_path.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/cvs2svn_lib/cvs_path.py b/cvs2svn_lib/cvs_path.py index 1f9fa528..0565e5d9 100644 --- a/cvs2svn_lib/cvs_path.py +++ b/cvs2svn_lib/cvs_path.py @@ -38,8 +38,10 @@ class CVSPath(object): parent_directory -- (CVSDirectory or None) the CVSDirectory containing this CVSPath. - basename -- (string) the base name of this CVSPath (no ',v'). The - basename of the root directory of a project is ''. + basename -- (string) the base name of the filename path in the CVS + repository corresponding to this CVSPath (but with ',v' + removed for CVSFiles). The basename of the root directory of + a project is ''. filename -- (string) the filesystem path to this CVSPath in the CVS repository. This is in native format, and already @@ -186,7 +188,9 @@ class CVSDirectory(CVSPath): parent_directory -- (CVSDirectory or None) the CVSDirectory containing this CVSDirectory. - basename -- (string) the base name of this CVSDirectory (no ',v'). + basename -- (string) the base name of the filename path in the CVS + repository corresponding to this CVSDirectory. The basename + of the root directory of a project is ''. ordinal -- (int) the order that this instance should be sorted relative to other CVSPath instances. See CVSPath.ordinal. @@ -252,7 +256,9 @@ class CVSFile(CVSPath): parent_directory -- (CVSDirectory) the CVSDirectory containing this CVSFile. - basename -- (string) the base name of this CVSFile (no ',v'). + basename -- (string) the base name of the RCS file in the CVS + repository corresponding to this CVSPath (but with the ',v' + removed). ordinal -- (int) the order that this instance should be sorted relative to other CVSPath instances. See CVSPath.ordinal. -- 2.11.4.GIT