[tor-commits] [stem/master] Escape asterisks in docs

[atagar@xxxxxxxxxxxxxx]

commit 4c2aca73612b4d915b3d36fdd9acb89a6b5c7880
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date:   Sun Dec 6 12:15:03 2015 -0800

    Escape asterisks in docs
    
    Just addressing a simple warning sphinx is giving us...
    
      stem/util/connection.py:docstring of stem.util.connection:37: WARNING: Inline emphasis start-string without end-string.
      stem/util/test_tools.py:docstring of stem.util.test_tools.clean_orphaned_pyc:1: WARNING: Inline emphasis start-string without end-string.
      stem/util/test_tools.py:docstring of stem.util.test_tools.clean_orphaned_pyc:1: WARNING: Inline emphasis start-string without end-string.
---
 stem/util/connection.py |    2 +-
 stem/util/test_tools.py |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/stem/util/connection.py b/stem/util/connection.py
index 951b020..ddc4f4e 100644
--- a/stem/util/connection.py
+++ b/stem/util/connection.py
@@ -37,7 +37,7 @@ Connection and networking based utility functions.
   **NETSTAT_WINDOWS**   netstat command under Windows
   **SS**                ss command
   **LSOF**              lsof command
-  **SOCKSTAT**          sockstat command under *nix
+  **SOCKSTAT**          sockstat command under \*nix
   **BSD_SOCKSTAT**      sockstat command under FreeBSD
   **BSD_PROCSTAT**      procstat command under FreeBSD
   ====================  ===========
diff --git a/stem/util/test_tools.py b/stem/util/test_tools.py
index 7c97444..bc54f94 100644
--- a/stem/util/test_tools.py
+++ b/stem/util/test_tools.py
@@ -44,7 +44,7 @@ class Issue(collections.namedtuple('Issue', ['line_number', 'message', 'line']))
 
 def clean_orphaned_pyc(paths):
   """
-  Deletes any file with a *.pyc extention without a corresponding *.py. This
+  Deletes any file with a \*.pyc extention without a corresponding \*.py. This
   helps to address a common gotcha when deleting python files...
 
   * You delete module 'foo.py' and run the tests to ensure that you haven't



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