From e186cfedadf43deb4b265d06be560bf5e5d81dc6 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Fri, 26 Oct 2012 08:42:14 -0400 Subject: [PATCH] doc: update :data: to :py:data: for modern Sphinx. --- libbe/storage/util/config.py | 4 ++-- libbe/storage/vcs/base.py | 10 +++++----- libbe/util/id.py | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/libbe/storage/util/config.py b/libbe/storage/util/config.py index 7e14b5d..4945b1f 100644 --- a/libbe/storage/util/config.py +++ b/libbe/storage/util/config.py @@ -67,7 +67,7 @@ def set_val(name, value, section="DEFAULT", encoding=None): section : str The section to store the name/value in. encoding : str - The config file's encoding, defaults to :data:`default_encoding`. + The config file's encoding, defaults to :py:data:`default_encoding`. """ if encoding == None: encoding = default_encoding @@ -97,7 +97,7 @@ def get_val(name, section="DEFAULT", default=None, encoding=None): default : The value to return if `name` is not set. encoding : str - The config file's encoding, defaults to :data:`default_encoding`. + The config file's encoding, defaults to :py:data:`default_encoding`. Examples -------- diff --git a/libbe/storage/vcs/base.py b/libbe/storage/vcs/base.py index 9de2fe3..845336d 100644 --- a/libbe/storage/vcs/base.py +++ b/libbe/storage/vcs/base.py @@ -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()) diff --git a/libbe/util/id.py b/libbe/util/id.py index 8605d09..de9edf9 100644 --- a/libbe/util/id.py +++ b/libbe/util/id.py @@ -464,7 +464,7 @@ REGEXP = '#([-a-f0-9]*)(/[-a-g0-9]*)?(/[-a-g0-9]*)?#' class IDreplacer (object): """Helper class for ID replacement in text. - Reassembles the match elements from :data:`REGEXP` matching + Reassembles the match elements from :py:data:`REGEXP` matching into the original ID, for easier replacement. See Also @@ -546,7 +546,7 @@ def _parse_user(id): information. The returned dict will contain a value for "type" (from - :data:`HIERARCHY`) and values for the levels that are defined. + :py:data:`HIERARCHY`) and values for the levels that are defined. Examples -------- @@ -589,7 +589,7 @@ def parse_user(bugdirs, id): information. The returned dict will contain a value for "type" (from - :data:`HIERARCHY`) and values for the levels that are defined. + :py:data:`HIERARCHY`) and values for the levels that are defined. Notes ----- -- 2.26.2