[tor-commits] [stem/master] Fix malformed class links

[atagar@xxxxxxxxxxxxxx]

commit 3339630ee286f4f1059a5a17db6d17b0f10f2c40
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date:   Tue May 12 16:52:28 2020 -0700

    Fix malformed class links
    
    Sphinx class references are of the form...
    
      :class:`module.class_name`
    
    Our new collector module lacked a trailing backtick in a few spots. This caused
    the following build warnings...
    
      /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.File.read:4: WARNING: Inline interpreted text or phrase reference start-string without end-string.
      /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_microdescriptors:22: WARNING: Inline interpreted text or phrase reference start-string without end-string.
      /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_key_certificates:12: WARNING: Inline interpreted text or phrase reference start-string without end-string.
      /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_bandwidth_files:12: WARNING: Inline interpreted text or phrase reference start-string without end-string.
      /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_exit_lists:12: WARNING: Inline interpreted text or phrase reference start-string without end-string.
---
 stem/descriptor/collector.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/stem/descriptor/collector.py b/stem/descriptor/collector.py
index 9749dadb..a978519d 100644
--- a/stem/descriptor/collector.py
+++ b/stem/descriptor/collector.py
@@ -212,7 +212,7 @@ class File(object):
     from disk as follows...
 
     * If this file has already been downloaded through
-      :func:`~stem.descriptor.collector.CollecTor.download' these descriptors
+      :func:`~stem.descriptor.collector.CollecTor.download` these descriptors
       are read from disk.
 
     * If a **directory** argument is provided and the file is already present
@@ -485,7 +485,7 @@ class CollecTor(object):
     :param int retries: maximum attempts to impose on a per-archive basis
 
     :returns: **iterator** of
-      :class:`~stem.descriptor.microdescriptor.Microdescriptor
+      :class:`~stem.descriptor.microdescriptor.Microdescriptor`
       for the given time range
 
     :raises: :class:`~stem.DownloadFailed` if the download fails
@@ -553,7 +553,7 @@ class CollecTor(object):
     :param int retries: maximum attempts to impose on a per-archive basis
 
     :returns: **iterator** of
-      :class:`~stem.descriptor.networkstatus.KeyCertificate
+      :class:`~stem.descriptor.networkstatus.KeyCertificate`
       for the given time range
 
     :raises: :class:`~stem.DownloadFailed` if the download fails
@@ -577,7 +577,7 @@ class CollecTor(object):
     :param int retries: maximum attempts to impose on a per-archive basis
 
     :returns: **iterator** of
-      :class:`~stem.descriptor.bandwidth_file.BandwidthFile
+      :class:`~stem.descriptor.bandwidth_file.BandwidthFile`
       for the given time range
 
     :raises: :class:`~stem.DownloadFailed` if the download fails
@@ -601,7 +601,7 @@ class CollecTor(object):
     :param int retries: maximum attempts to impose on a per-archive basis
 
     :returns: **iterator** of
-      :class:`~stem.descriptor.tordnsel.TorDNSEL
+      :class:`~stem.descriptor.tordnsel.TorDNSEL`
       for the given time range
 
     :raises: :class:`~stem.DownloadFailed` if the download fails



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits