[tor-commits] [stem/master] Deprecate the DescriptorReader class

[atagar at torproject.org]

commit 8d43e5810c8a9c72bd05bcda0b16d633696c7f7b
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Nov 27 18:53:14 2018 -0800

    Deprecate the DescriptorReader class
    
    Does anyone use this? Written in response to a request from Karsten when I
    first began stem I've never heard of someone actually using it. To simplify,
    lets drop it.
---
 stem/descriptor/reader.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/stem/descriptor/reader.py b/stem/descriptor/reader.py
index 9889751b..ca087ec6 100644
--- a/stem/descriptor/reader.py
+++ b/stem/descriptor/reader.py
@@ -75,6 +75,11 @@ and picks up where it left off if run again...
     |- UnrecognizedType - File extension indicates non-descriptor data
     +- ReadFailed - Wraps an error that was raised while reading the file
        +- FileMissing - File does not exist
+
+.. deprecated:: 1.8.0
+
+   This module will likely be removed in Stem 2.0 due to lack of usage. If you
+   use this modle please `let me know <https://www.atagar.com/contact/>`_.
 """
 
 import mimetypes