[tor-commits] [stem/master] Document conn_type rename

[atagar at torproject.org]

commit fea9015248c3ebefacfa6b958e946ac7eb38c81c
Author: Damian Johnson <atagar at torproject.org>
Date:   Fri Mar 31 10:05:01 2017 -0700

    Document conn_type rename
    
    Very minor tweak for...
    
      https://trac.torproject.org/projects/tor/ticket/21774
---
 docs/change_log.rst     | 1 +
 stem/response/events.py | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/docs/change_log.rst b/docs/change_log.rst
index bad162b..2c18560 100644
--- a/docs/change_log.rst
+++ b/docs/change_log.rst
@@ -45,6 +45,7 @@ The following are only available within Stem's `git repository
 
  * **Controller**
 
+  * Renamed :class:`~stem.response.events.ConnectionBandwidthEvent` type attribute to conn_type to avoid conflict with parent class (:trac:`21774`)
   * Added the GUARD_WAIT :data:`~stem.CircStatus` (:spec:`6446210`)
   * Unable to use cookie auth when path includes wide characters (chinese, japanese, etc)
   * Tor change caused :func:`~stem.control.Controller.list_ephemeral_hidden_services` to provide empty strings if unset (:trac:`21329`)
diff --git a/stem/response/events.py b/stem/response/events.py
index 1691ebf..3aa5673 100644
--- a/stem/response/events.py
+++ b/stem/response/events.py
@@ -1112,6 +1112,10 @@ class ConnectionBandwidthEvent(Event):
 
   .. versionadded:: 1.2.0
 
+  .. versionchanged:: 1.6.0
+     Renamed 'type' attribute to 'conn_type' so it wouldn't be override parent
+     class attribute with the same name.
+
   :var str id: connection identifier
   :var stem.ConnectionType conn_type: connection type
   :var long read: bytes received by tor that second