Changeset 311 in tailor

Timestamp:

05/20/05 11:30:00 (8 years ago)

Author:

lele@…

Hash name:

20050520093000-97f81-7a8ffb6ccafafe4a7ce7adc0943509f5eff89487

Message:

Little documentation fixes to make epydoc happy

Location:

vcpx

Files:

• changes.py (modified) (2 diffs)
• cvsps.py (modified) (3 diffs)
• source.py (modified) (2 diffs)
• target.py (modified) (5 diffs)
• darcs.py (modified) (5 diffs)
• svn.py (modified) (1 diff)
• shwrap.py (modified) (1 diff)
• tailor.py (modified) (4 diffs)
• cdv.py (modified) (1 diff)
• bzr.py (modified) (1 diff)

vcpx/changes.py

@@ -17 +17 @@
     Represent a changed entry in a Changeset.
 
-    For our scope, this simply means an entry `name`, the original
-    `old_revision`, the `new_revision` after this change, an
-    `action_kind` to denote the kind of change, and finally a `status`
+    For our scope, this simply means an entry ``name``, the original
+    ``old_revision``, the ``new_revision`` after this change, an
+    ``action_kind`` to denote the kind of change, and finally a ``status``
     to indicate possible conflicts.
     """
@@ -65 +65 @@
 
     Normalize the message reducing multiple spaces and newlines to single
-    spaces, recognizing common form of `bullet lists`, that is paragraphs
+    spaces, recognizing common form of ``bullet lists``, that is paragraphs
     starting with either a dash "-" or an asterisk "*".
     """

vcpx/cvsps.py

@@ -306 +306 @@
                 
     def _checkoutUpstreamRevision(self, basedir, repository, module, revision,
-                                  subdir=None, logger=None):
+                                  subdir=None, logger=None, **kwargs):
         """
         Concretely do the checkout of the upstream sources. Use `revision` as
@@ -367 +367 @@
         return last.revision
     
-    def _willApplyChangeset(self, root, changeset, applyable):
+    def _willApplyChangeset(self, root, changeset, applyable=None):
         """
         This gets called just before applying each changeset.
@@ -460 +460 @@
 
         This is to prevent silly errors such those that could arise
-        after a manual `cvs update` in the working directory.
+        after a manual ``cvs update`` in the working directory.
         """
         

vcpx/source.py

@@ -44 +44 @@
     """
     This is an abstract working dir able to follow an upstream
-    source of `changesets`.
+    source of ``changesets``.
 
-    It has two main functionalities:
+    It has three main functionalities:
 
     getUpstreamChangesets
@@ -181 +181 @@
         
     def _checkoutUpstreamRevision(self, basedir, repository, module, revision,
-                                  logger=None, **kwargs):
+                                  subdir=None, logger=None, **kwargs):
         """
         Concretely do the checkout of the upstream revision.

vcpx/target.py

@@ -44 +44 @@
         performed by the upstream VC system on the tree such as
         renames, deletions and adds.  This is an useful argument to
-        feed as `replay` to `applyUpstreamChangesets`
+        feed as ``replay`` to ``applyUpstreamChangesets``
 
     initializeNewWorkingDir
@@ -70 +70 @@
         changeset.
 
-        If `delayed_commit` is not True, the changeset is committed
+        If ``delayed_commit`` is not True, the changeset is committed
         to the target VC right after a successful application; otherwise
         the various information get registered and will be reused later,
@@ -115 +115 @@
         commit of all changed entries.
 
-        With `concatenate_logs` there's control over the folded
+        With ``concatenate_logs`` there's control over the folded
         changesets message log: if True every changelog is appended in
         order of application, otherwise it will contain just the name
@@ -304 +304 @@
             self._renamePathname(root, e.old_name, e.name)
         
-    def _renamePathname(self, root, oldentry, newentry):
+    def _renamePathname(self, root, oldname, newname):
         """
         Rename a filesystem object to some other name/location.
@@ -328 +328 @@
     def _initializeWorkingDir(self, root, repository, module, subdir):
         """
-        Assuming the `root` directory contains a working copy `module`
+        Assuming the ``root`` directory contains a working copy ``module``
         extracted from some VC repository, add it and all its content
         to the target repository.

vcpx/darcs.py

@@ -8 +8 @@
 
 """
-This module contains supporting classes for the `darcs` versioning system.
+This module contains supporting classes for the ``darcs`` versioning system.
 """
 
@@ -45 +45 @@
     Parse XML output of ``darcs changes``.
 
-    Return a list of `Changeset`s.
+    Return a list of ``Changeset`` instances.
     """
     
@@ -214 +214 @@
 
     def _checkoutUpstreamRevision(self, basedir, repository, module, revision,
-                                  subdir=None, logger=None):
+                                  subdir=None, logger=None, **kwargs):
         """
         Concretely do the checkout of the upstream revision.
@@ -294 +294 @@
     def _addSubtree(self, root, subdir):
         """
-        Use the --recursive variant of `darcs add` to add a subtree.
+        Use the --recursive variant of ``darcs add`` to add a subtree.
         """
         
@@ -363 +363 @@
     def _initializeWorkingDir(self, root, repository, module, subdir):
         """
-        Execute `darcs initialize` and tweak the default settings of
+        Execute ``darcs initialize`` and tweak the default settings of
         the repository, then add the whole subtree.
         """

vcpx/svn.py

@@ -306 +306 @@
         
     def _checkoutUpstreamRevision(self, basedir, repository, module, revision,
-                                  subdir=None, logger=None):
+                                  subdir=None, logger=None, **kwargs):
         """
         Concretely do the checkout of the upstream revision.

vcpx/shwrap.py

@@ -58 +58 @@
 class VerboseStringIO(StringIO):
 
-    def write(self, data):        
+    def write(self, s):
         """Give a feedback to the user."""
         
-        StringIO.write(self, data)
-        stderr.write('.'*data.count('\n'))
+        StringIO.write(self, s)
+        stderr.write('.'*s.count('\n'))
 
 def joinall(threadlist):

vcpx/tailor.py

@@ -12 +12 @@
 This implementation stores the relevant project information, needed to
 keep the whole thing going on, such as the last synced revision, in a
-unversioned file named `tailor.info` at the root.
+unversioned file named ``tailor.info`` at the root.
 """
 
@@ -26 +26 @@
 def relpathto(source, dest):
     """
-    Compute the relative path needed to point `source` from `dest`.
-
-    Warning: `dest` is assumed to be a directory.
+    Compute the relative path needed to point ``source`` from ``dest``.
+
+    Warning: ``dest`` is assumed to be a directory.
     """
     
@@ -289 +289 @@
         Bootstrap a new tailorized module.
 
-        Extract a copy of the `repository` at given `revision` in the `root`
-        directory and initialize a target repository with its content.
+        Extract a copy of the ``repository`` at given ``revision`` in the
+        ``root`` directory and initialize a target repository with its content.
 
         The actual information on the project are stored in a text file.
@@ -376 +376 @@
 
         Fetch the upstream changesets and apply them to the working copy.
-        Use the information stored in the `tailor.info` file to ask just
+        Use the information stored in the ``tailor.info`` file to ask just
         the new changeset since last bootstrap/synchronization.
         """

vcpx/cdv.py

@@ -97 +97 @@
     def _initializeWorkingDir(self, root, repository, module, subdir):
         """
-        Execute `cdv init`.
+        Execute ``cdv init``.
         """
 

vcpx/bzr.py

@@ -94 +94 @@
     def _initializeWorkingDir(self, root, repository, module, subdir):
         """
-        Execute `bzr init`.
+        Execute ``bzr init``.
         """