[tor-commits] [stem/master] Vending the test_tools and tor_tools utility modules

[atagar@xxxxxxxxxxxxxx]

commit 29f2a1cde6f6bc4fb523a410568559d9bd2c142e
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date:   Sat May 31 11:35:07 2014 -0700

    Vending the test_tools and tor_tools utility modules
    
    On reflection both are very well written and tested. I've found these useful in
    my projects and there's little reason so keep 'em to ourselves so sharing the
    wealth.
---
 docs/api.rst                 |    2 ++
 docs/api/util/test_tools.rst |    5 +++++
 docs/change_log.rst          |    2 ++
 docs/contents.rst            |    1 +
 stem/util/test_tools.py      |    4 ----
 stem/util/tor_tools.py       |    3 ---
 6 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/docs/api.rst b/docs/api.rst
index 56b9d54..4f1a01c 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -49,4 +49,6 @@ Utilities
 * `stem.util.str_tools <api/util/str_tools.html>`_ - String utilities.
 * `stem.util.system <api/util/system.html>`_ - Tools related to the local system.
 * `stem.util.term <api/util/term.html>`_ - Tools for interacting with the terminal.
+* `stem.util.test_tools <api/util/test_tools.html>`_ - Static analysis checks and tools to help with test runs.
+* `stem.util.tor_tools <api/util/tor_tools.html>`_ - Miscellaneous toolkit for working with tor.
 
diff --git a/docs/api/util/test_tools.rst b/docs/api/util/test_tools.rst
new file mode 100644
index 0000000..113ca64
--- /dev/null
+++ b/docs/api/util/test_tools.rst
@@ -0,0 +1,5 @@
+Test Utilities
+==============
+
+.. automodule:: stem.util.test_tools
+
diff --git a/docs/change_log.rst b/docs/change_log.rst
index ac892d1..6b71913 100644
--- a/docs/change_log.rst
+++ b/docs/change_log.rst
@@ -62,6 +62,8 @@ The following are only available within Stem's `git repository
 
  * **Utilities**
 
+  * Added the `stem.util.test_tools <api/util/test_tools.html>`_ module
+  * Started vending the `stem.util.tor_tools <api/util/tor_tools.html>`_ module
   * Added :func:`stem.util.connection.port_usage`
   * Added :func:`stem.util.system.files_with_suffix`
 
diff --git a/docs/contents.rst b/docs/contents.rst
index 6667123..15283f1 100644
--- a/docs/contents.rst
+++ b/docs/contents.rst
@@ -53,5 +53,6 @@ Contents
    api/util/str_tools
    api/util/system
    api/util/term
+   api/util/test_tools
    api/util/tor_tools
 
diff --git a/stem/util/test_tools.py b/stem/util/test_tools.py
index b95cbd5..cd94ff5 100644
--- a/stem/util/test_tools.py
+++ b/stem/util/test_tools.py
@@ -4,10 +4,6 @@
 """
 Helper functions for testing.
 
-**Stem users are more than welcome to use these for their own test runs, but
-these functions are not being vended to our users. They may change in the
-future, use them at your own risk.**
-
 ::
 
   clean_orphaned_pyc - delete *.pyc files without corresponding *.py
diff --git a/stem/util/tor_tools.py b/stem/util/tor_tools.py
index 325fcbe..aae7426 100644
--- a/stem/util/tor_tools.py
+++ b/stem/util/tor_tools.py
@@ -4,9 +4,6 @@
 """
 Miscellaneous utility functions for working with tor.
 
-**These functions are not being vended to stem users. They may change in the
-future, use them at your own risk.**
-
 **Module Overview:**
 
 ::



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