[Pkg-privacy-commits] [txtorcon] 40/96: minor documentation fixups

[Jérémy Bobbio]

This is an automated email from the git hooks/post-receive script.

lunar pushed a commit to branch master
in repository txtorcon.

commit bc7be21356ff0605ac3f7764fc8f52171c7fff93
Author: meejah <meejah at meejah.ca>
Date:   Wed Jan 28 02:32:48 2015 -0700

    minor documentation fixups
---
 docs/txtorcon-config.rst       | 2 +-
 docs/txtorcon-endpoints.rst    | 6 +++---
 docs/txtorcon-state.rst        | 2 +-
 txtorcon/circuit.py            | 4 ++--
 txtorcon/stream.py             | 2 +-
 txtorcon/torcontrolprotocol.py | 2 +-
 txtorcon/torstate.py           | 4 ++++
 7 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/docs/txtorcon-config.rst b/docs/txtorcon-config.rst
index 27f2280..fd85035 100644
--- a/docs/txtorcon-config.rst
+++ b/docs/txtorcon-config.rst
@@ -6,5 +6,5 @@ TorConfig
 .. autoclass:: txtorcon.TorConfig
 
 HiddenService
----------
+-------------
 .. autoclass:: txtorcon.HiddenService
diff --git a/docs/txtorcon-endpoints.rst b/docs/txtorcon-endpoints.rst
index 938211b..c8a7326 100644
--- a/docs/txtorcon-endpoints.rst
+++ b/docs/txtorcon-endpoints.rst
@@ -24,9 +24,9 @@ TorOnionListeningPort
 IProgressProvider
 -----------------
 
-.. autoclass:: txtorcon.IProgressProvider
+.. autointerface:: txtorcon.IProgressProvider
 
 IHiddenService
------------------
+--------------
 
-.. autoclass:: txtorcon.IHiddenService
+.. autointerface:: txtorcon.IHiddenService
diff --git a/docs/txtorcon-state.rst b/docs/txtorcon-state.rst
index e59d7ca..eb4c656 100644
--- a/docs/txtorcon-state.rst
+++ b/docs/txtorcon-state.rst
@@ -9,7 +9,7 @@ build_tor_connection
 .. autofunction:: txtorcon.build_tor_connection
 
 build_local_tor_connection
---------------------
+--------------------------
 .. autofunction:: txtorcon.build_local_tor_connection
 
 TorState
diff --git a/txtorcon/circuit.py b/txtorcon/circuit.py
index 5124f9e..2228381 100644
--- a/txtorcon/circuit.py
+++ b/txtorcon/circuit.py
@@ -54,7 +54,7 @@ class Circuit(object):
           - TESTING
           - CONTROLLER
 
-        For most purposes, you'll want to look at GENERAL circuits only.
+    For most purposes, you'll want to look at GENERAL circuits only.
 
 
     :ivar id:
@@ -105,7 +105,7 @@ class Circuit(object):
     def close(self, **kw):
         """
         This asks Tor to close the underlying circuit object. See
-        :method:`txtorcon.torstate.TorState.close_circuit`
+        :meth:`txtorcon.torstate.TorState.close_circuit`
         for details.
 
         You may pass keyword arguments to take care of any Flags Tor
diff --git a/txtorcon/stream.py b/txtorcon/stream.py
index 3cc8ec5..4f3b933 100644
--- a/txtorcon/stream.py
+++ b/txtorcon/stream.py
@@ -125,7 +125,7 @@ class Stream(object):
     def close(self, **kw):
         """
         This asks Tor to close the underlying stream object. See
-        :method:`txtorcon.interface.ITorControlProtocol.close_stream`
+        :meth:`txtorcon.interface.ITorControlProtocol.close_stream`
         for details.
 
         Although Tor currently takes no flags, it allows you to; any
diff --git a/txtorcon/torcontrolprotocol.py b/txtorcon/torcontrolprotocol.py
index 5a6ed45..ab5d8be 100644
--- a/txtorcon/torcontrolprotocol.py
+++ b/txtorcon/torcontrolprotocol.py
@@ -184,7 +184,7 @@ class TorControlProtocol(LineOnlyReceiver):
     :meth:`txtorcon.TorState.build_circuit` allows you to build custom
     circuits.
 
-    :meth:`txtorcon.TorControlProtocol.add_event_listener` can be used
+   :meth:`txtorcon.TorControlProtocol.add_event_listener` can be used
     to listen for specific events.
 
     To see how circuit and stream listeners are used, see
diff --git a/txtorcon/torstate.py b/txtorcon/torstate.py
index 1431b52..1f7efa2 100644
--- a/txtorcon/torstate.py
+++ b/txtorcon/torstate.py
@@ -165,6 +165,10 @@ class TorState(object):
     This is also a good example of the various listeners, and acts as
     an :class:`txtorcon.interface.ICircuitContainer` and
     :class:`txtorcon.interface.IRouterContainer`.
+
+    :cvar DO_NOT_ATTACH:
+    Constant to return from an IAttacher indicating you don't want to
+    attach this stream at all.
     """
 
     implements(ICircuitListener, ICircuitContainer, IRouterContainer,

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/txtorcon.git