[tor-commits] [stem/master] Can't do nested inline sphinx markup

[atagar at torproject.org]

commit 4163f9e627a24731763e390c8f6ffd061e061777
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon Dec 7 07:59:38 2015 -0800

    Can't do nested inline sphinx markup
    
    Turns out we can't do :class: and such when we have bold text. This
    is rendering as...
    
      The dictionary you get from this is manged by the
      :class:`~stem.util.conf.Config` class and should be treated as being
      read-only.
    
    Feels like a Sphinx bug but they mention it on...
    
      http://sphinx-doc.org/rest.html#gotchas
---
 stem/util/conf.py |    5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/stem/util/conf.py b/stem/util/conf.py
index c2cfd5f..fcf6858 100644
--- a/stem/util/conf.py
+++ b/stem/util/conf.py
@@ -215,9 +215,8 @@ def config_dict(handle, conf_mappings, handler = None):
   For more information about how we convert types see our
   :func:`~stem.util.conf.Config.get` method.
 
-  **The dictionary you get from this is manged by the
-  :class:`~stem.util.conf.Config` class and should be treated as being
-  read-only.**
+  **The dictionary you get from this is manged by the Config class and should
+  be treated as being read-only.**
 
   :param str handle: unique identifier for a config instance
   :param dict conf_mappings: config key/value mappings used as our defaults