[PATCH] Scattered docstring fixes
Greg Ward <[email protected]>
| Newsgroups | gmane.comp.version-control.subversion.cvs2svn.devel |
|---|---|
| Message-ID | <1eab58eb227dd1197744.1250598555@davros> |
* cvs2svn_lib/context.py: grammar fix in class docstring * cvs2svn_lib/fulltext_revision_recorder.py: s/overwritten/overridden/ * cvs2svn_lib/git_revision_recorder.py: rewrite inaccurate module docstring * cvs2svn_lib/output_option.py: fix typo * cvs2svn_lib/repository_mirror.py: fix typo ------------------------------------------------------ http://cvs2svn.tigris.org/ds/viewMessage.do?dsForumId=1667&dsMessageId=2384731 To unsubscribe from this discussion, e-mail: [[email protected]].
doc-comment.patch
(text/x-patch, 3.6 KB)
# HG changeset patch # User Greg Ward <[email protected]> # Date 1250598491 14400 # Node ID 1eab58eb227dd1197744dd39975e6a1845e57c33 # Parent 51491c8f066f972d7d942f81e109dadc3f84ddfc Scattered docstring fixes. * cvs2svn_lib/context.py: grammar fix in class docstring * cvs2svn_lib/fulltext_revision_recorder.py: s/overwritten/overridden/ * cvs2svn_lib/git_revision_recorder.py: rewrite inaccurate module docstring * cvs2svn_lib/output_option.py: fix typo * cvs2svn_lib/repository_mirror.py: fix typo diff --git a/cvs2svn_lib/context.py b/cvs2svn_lib/context.py --- a/cvs2svn_lib/context.py +++ b/cvs2svn_lib/context.py @@ -24,8 +24,8 @@ class Ctx: """Session state for this run of cvs2svn. For example, run-time - options are stored here. This class is a Borg, see - http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66531.""" + options are stored here. This class is a Borg (see + http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66531).""" __shared_state = { } diff --git a/cvs2svn_lib/fulltext_revision_recorder.py b/cvs2svn_lib/fulltext_revision_recorder.py --- a/cvs2svn_lib/fulltext_revision_recorder.py +++ b/cvs2svn_lib/fulltext_revision_recorder.py @@ -17,7 +17,7 @@ """An abstract class that contructs file contents during CollectRevsPass. It calls its record_fulltext() method with the full text of every -revision. This method should be overwritten to do something with the +revision. This method should be overridden to do something with the fulltext and possibly return a revision_recorder_token.""" @@ -73,7 +73,7 @@ self.fulltext_revision_recorder.start_file(cvs_file_items) def record_text(self, cvs_rev, log, text): - """This method should be overwritten. + """This method should be overwridden. It should determine the fulltext of CVS_REV, then pass it to self.fulltext_revision_recorder.record_fulltext() and return the diff --git a/cvs2svn_lib/git_revision_recorder.py b/cvs2svn_lib/git_revision_recorder.py --- a/cvs2svn_lib/git_revision_recorder.py +++ b/cvs2svn_lib/git_revision_recorder.py @@ -14,11 +14,7 @@ # history and logs, available at http://cvs2svn.tigris.org/. # ==================================================================== -"""An abstract class that contructs file contents during CollectRevsPass. - -It calls its record_fulltext() method with the full text of every -revision. This method should be overwritten to do something with the -fulltext and possibly return a revision_recorder_token.""" +"""Write file contents to a stream of git-fast-import blobs.""" import itertools diff --git a/cvs2svn_lib/output_option.py b/cvs2svn_lib/output_option.py --- a/cvs2svn_lib/output_option.py +++ b/cvs2svn_lib/output_option.py @@ -58,7 +58,7 @@ raise NotImplementedError() def process_primary_commit(self, svn_commit): - """Process SVN_COMMIT, which is an SVNInitialProjectCommit.""" + """Process SVN_COMMIT, which is an SVNPrimaryCommit.""" raise NotImplementedError() diff --git a/cvs2svn_lib/repository_mirror.py b/cvs2svn_lib/repository_mirror.py --- a/cvs2svn_lib/repository_mirror.py +++ b/cvs2svn_lib/repository_mirror.py @@ -17,7 +17,7 @@ """This module contains the RepositoryMirror class and supporting classes. RepositoryMirror represents the skeleton of a versioned file tree with -multiple lines of development ('LODs'). It records the presence of +multiple lines of development ('LODs'). It records the presence or absence of files and directories, but not their contents. Given three values (revnum, lod, cvs_path), it can tell you whether the specified CVSPath existed on the specified LOD in the given revision number.