[tor-commits] [stem/master] Removing double backticks from None documentation

[atagar@xxxxxxxxxxxxxx]

commit e13ea63c09e766d15c36983c9b37f6adde1a2bde
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date:   Tue Jun 5 20:14:39 2012 -0700

    Removing double backticks from None documentation
    
    Double backticks should be monospaced, but with the haiku theme it's an
    inverted background with is far more noticeable. I didn't mean to accent 'None'
    this much so dropping the formatting from it.
---
 stem/response/protocolinfo.py |    3 +--
 stem/util/log.py              |    6 +++---
 stem/util/proc.py             |    2 +-
 stem/util/system.py           |   10 +++++-----
 4 files changed, 10 insertions(+), 11 deletions(-)

diff --git a/stem/response/protocolinfo.py b/stem/response/protocolinfo.py
index ece96a3..0a9d94d 100644
--- a/stem/response/protocolinfo.py
+++ b/stem/response/protocolinfo.py
@@ -34,8 +34,7 @@ class ProtocolInfoResponse(stem.response.ControlMessage):
   Version one PROTOCOLINFO query response.
   
   The protocol_version is the only mandatory data for a valid PROTOCOLINFO
-  response, so all other values are ``None`` if undefined or empty if a
-  collection.
+  response, so all other values are None if undefined or empty if a collection.
   
   :var int protocol_version: protocol version of the response
   :var stem.version.Version tor_version: version of the tor process
diff --git a/stem/util/log.py b/stem/util/log.py
index 59c4a85..c2eb817 100644
--- a/stem/util/log.py
+++ b/stem/util/log.py
@@ -88,7 +88,7 @@ def logging_level(runlevel):
   """
   Translates a runlevel into the value expected by the logging module.
   
-  :param Runlevel runlevel: runlevel to be returned, no logging if ``None``
+  :param Runlevel runlevel: runlevel to be returned, no logging if None
   """
   
   if runlevel: return LOG_VALUES[runlevel]
@@ -112,7 +112,7 @@ def log(runlevel, message):
   """
   Logs a message at the given runlevel.
   
-  :param Runlevel runlevel: runlevel to log the message at, logging is skipped if ``None``
+  :param Runlevel runlevel: runlevel to log the message at, logging is skipped if None
   :param str message: message to be logged
   """
   
@@ -125,7 +125,7 @@ def log_once(message_id, runlevel, message):
   been logged then this is a no-op.
   
   :param str message_id: unique message identifier to deduplicate on
-  :param Runlevel runlevel: runlevel to log the message at, logging is skipped if ``None``
+  :param Runlevel runlevel: runlevel to log the message at, logging is skipped if None
   :param str message: message to be logged
   
   :returns: True if we log the message, False otherwise
diff --git a/stem/util/proc.py b/stem/util/proc.py
index 5ca0520..26048df 100644
--- a/stem/util/proc.py
+++ b/stem/util/proc.py
@@ -173,7 +173,7 @@ def get_memory_usage(pid):
   
   :param int pid: process id of the process to be queried
   
-  :returns: tuple of two ints with the memory usage of the process, of the form ``(residentSize, virtualSize)``
+  :returns: tuple of two ints with the memory usage of the process, of the form ``(resident_size, virtual_size)``
   
   :raises: IOError if it can't be determined
   """
diff --git a/stem/util/system.py b/stem/util/system.py
index e5583bc..559eaa0 100644
--- a/stem/util/system.py
+++ b/stem/util/system.py
@@ -1,7 +1,7 @@
 """
 Helper functions for working with the underlying system. These are mostly os
 dependent, only working on linux, osx, and bsd. In almost all cases they're
-best-effort, providing ``None`` if the lookup fails.
+best-effort, providing None if the lookup fails.
 
 **Module Overview:**
 
@@ -102,7 +102,7 @@ def is_running(command):
   
   :param str command: process name to be checked
   
-  :returns: True if the process is running, False if it's not among ps results, and ``None`` if ps can't be queried
+  :returns: True if the process is running, False if it's not among ps results, and None if ps can't be queried
   """
   
   # Linux and the BSD families have different variants of ps. Guess based on
@@ -398,7 +398,7 @@ def get_cwd(pid):
   Provices the working directory of the given process.
   
   :param int pid: process id of the process to be queried
-  :returns: str with the absolute path for the process' present working directory, ``None`` if it can't be determined
+  :returns: str with the absolute path for the process' present working directory, None if it can't be determined
   """
   
   # try fetching via the proc contents if it's available
@@ -495,7 +495,7 @@ def expand_path(path, cwd = None):
   unix-specific and paths never have an ending slash.
   
   :param str path: path to be expanded
-  :param str cwd: current working directory to expand relative paths with, our process' if this is ``None``
+  :param str cwd: current working directory to expand relative paths with, our process' if this is None
   
   :returns: str of the path expanded to be an absolute path
   """
@@ -533,7 +533,7 @@ def call(command, suppress_exc = True):
   :param str command: command to be issued
   :param bool suppress_exc: if True then None is returned on failure, otherwise this raises the exception
   
-  :returns: list with the lines of output from the command, ``None`` in case of failure if suppress_exc is True
+  :returns: list with the lines of output from the command, None in case of failure if suppress_exc is True
   
   :raises: OSError if this fails and suppress_exc is False
   """



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