[tor-commits] [stem/master] Using versionchanged for util function name notices

[atagar at torproject.org]

commit 0ea2d69e1f630cff9683fd9816eece29ff28b8ea
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Sep 2 07:24:16 2014 -0700

    Using versionchanged for util function name notices
    
    Using Sphinx's versionchanged to indicate that the function names are changing
    in the next release.
---
 docs/change_log.rst    |    1 +
 stem/util/proc.py      |    5 +++--
 stem/util/str_tools.py |    5 +++--
 stem/util/system.py    |    5 +++--
 4 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/docs/change_log.rst b/docs/change_log.rst
index dbb5581..bdd3dfb 100644
--- a/docs/change_log.rst
+++ b/docs/change_log.rst
@@ -55,6 +55,7 @@ The following are only available within Stem's `git repository
   * Changed :func:`stem.util.conf.uses_settings` to only provide a 'config' keyword arument if the decorated function would accept it.
   * Added :func:`stem.util.str_tools.crop`
   * Added :func:`stem.util.proc.get_file_descriptors_used`
+  * Dropped the 'get_*' prefix from most function names. Old names will still work, but are a deprecated alias.
 
  * **Interpreter**
 
diff --git a/stem/util/proc.py b/stem/util/proc.py
index 85a7501..184e450 100644
--- a/stem/util/proc.py
+++ b/stem/util/proc.py
@@ -15,8 +15,9 @@ Dave Daeschler, Giampaolo Rodola' and is under the BSD license.
 **These functions are not being vended to stem users. They may change in the
 future, use them at your own risk.**
 
-**Note:** Many functions were previously named with a get_* prefix. Those names
-are now aliases, and will be dropped in Stem version 2.0.0.
+.. versionchanged:: 1.3.0
+   Dropped the get_* prefix from several function names. The old names still
+   work, but are deprecated aliases.
 
 **Module Overview:**
 
diff --git a/stem/util/str_tools.py b/stem/util/str_tools.py
index 4bba8e3..33ecb84 100644
--- a/stem/util/str_tools.py
+++ b/stem/util/str_tools.py
@@ -4,8 +4,9 @@
 """
 Toolkit for various string activity.
 
-**Note:** Many functions were previously named with a get_* prefix. Those names
-are now aliases, and will be dropped in Stem version 2.0.0.
+.. versionchanged:: 1.3.0
+   Dropped the get_* prefix from several function names. The old names still
+   work, but are deprecated aliases.
 
 **Module Overview:**
 
diff --git a/stem/util/system.py b/stem/util/system.py
index 47023f4..adfc802 100644
--- a/stem/util/system.py
+++ b/stem/util/system.py
@@ -6,8 +6,9 @@ Helper functions for working with the underlying system. These are mostly os
 dependent, only working on linux, osx, and bsd. In almost all cases they're
 best-effort, providing **None** if the lookup fails.
 
-**Note:** Many functions were previously named with a get_* prefix. Those names
-are now aliases, and will be dropped in Stem version 2.0.0.
+.. versionchanged:: 1.3.0
+   Dropped the get_* prefix from several function names. The old names still
+   work, but are deprecated aliases.
 
 **Module Overview:**