X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=libbe%2Fstorage%2Fvcs%2Fbase.py;h=845336daf86dad8587e706678ca38bb718ae33f3;hb=e186cfedadf43deb4b265d06be560bf5e5d81dc6;hp=2a5f60033cd2344492426cd5ab3638e3cddd912b;hpb=9e5b28a346b2f6d82a0dd00db7a9ee65f8e29a8f;p=be.git diff --git a/libbe/storage/vcs/base.py b/libbe/storage/vcs/base.py index 2a5f600..845336d 100644 --- a/libbe/storage/vcs/base.py +++ b/libbe/storage/vcs/base.py @@ -3,7 +3,7 @@ # Ben Finney # Chris Ball # Gianluca Montecchi -# W. Trevor King +# W. Trevor King # # This file is part of Bugs Everywhere. # @@ -20,7 +20,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the base :class:`VCS` (Version Control System) class, which +"""Define the base :py:class:`VCS` (Version Control System) class, which should be subclassed by other Version Control System backends. The base class implements a "do not version" VCS. """ @@ -57,7 +57,7 @@ Don't list this module, it is implicitly last. """ def set_preferred_vcs(name): - """Manipulate :data:`VCS_ORDER` to place `name` first. + """Manipulate :py:data:`VCS_ORDER` to place `name` first. This is primarily indended for testing purposes. """ @@ -70,7 +70,7 @@ def set_preferred_vcs(name): def _get_matching_vcs(matchfn): """Return the first module for which matchfn(VCS_instance) is True. - Searches in :data:`VCS_ORDER`. + Searches in :py:data:`VCS_ORDER`. """ for submodname in VCS_ORDER: module = import_by_name('libbe.storage.vcs.%s' % submodname) @@ -82,7 +82,7 @@ def _get_matching_vcs(matchfn): def vcs_by_name(vcs_name): """Return the module for the VCS with the given name. - Searches in :data:`VCS_ORDER`. + Searches in :py:data:`VCS_ORDER`. """ if vcs_name == VCS.name: return new() @@ -91,14 +91,14 @@ def vcs_by_name(vcs_name): def detect_vcs(dir): """Return an VCS instance for the vcs being used in this directory. - Searches in :data:`VCS_ORDER`. + Searches in :py:data:`VCS_ORDER`. """ return _get_matching_vcs(lambda vcs: vcs._detect(dir)) def installed_vcs(): """Return an instance of an installed VCS. - Searches in :data:`VCS_ORDER`. + Searches in :py:data:`VCS_ORDER`. """ return _get_matching_vcs(lambda vcs: vcs.installed()) @@ -143,7 +143,7 @@ class CachedPathID (object): .../.be/BUGDIR/bugs/BUG/comments/COMMENT ^-- root path - See :mod:`libbe.util.id` for a discussion of ID formats. + See :py:mod:`libbe.util.id` for a discussion of ID formats. Examples -------- @@ -1032,7 +1032,7 @@ class VCS (libbe.storage.base.VersionedStorage): return relpath def _u_abspath(self, path, root=None): - """Return the absolute path from a path realtive to root. + """Return the absolute path from a path relative to root. Examples -------- @@ -1069,7 +1069,7 @@ class VCS (libbe.storage.base.VersionedStorage): See Also -------- - :mod:`libbe.storage.util.upgrade` + libbe.storage.util.upgrade """ if path == None: path = os.path.join(self.repo, '.be', 'version') @@ -1169,7 +1169,7 @@ if libbe.TESTING == True: class VCS_get_user_id_TestCase(VCSTestCase): """Test cases for VCS.get_user_id method.""" - def test_gets_existing_user_id(self): + def test_get_existing_user_id(self): """Should get the existing user ID.""" if self.s.installed(): user_id = self.s.get_user_id()