[Pkg-privacy-commits] [pyptlib] 129/136: Add a ChangeLog entry for #8956 and improve some docs.

[Ximin Luo]

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

infinity0 pushed a commit to branch master
in repository pyptlib.

commit 1f1067eef50d18ad5de71de10d26f959b3a66a59
Author: George Kadianakis <desnacked at riseup.net>
Date:   Wed Apr 16 16:14:20 2014 +0300

    Add a ChangeLog entry for #8956 and improve some docs.
    
    Original commit by Yawning Angel.
---
 ChangeLog                |  5 +++--
 pyptlib/client_config.py | 10 ++++++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 1614ad0..84ced1c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,7 @@
 Changes in version 0.0.6 - UNRELEASED
- - Add support for TOR_PT_PROXY to allow client side proxy use.  Patch by
-   Yawning Angel.
+ - Add support for TOR_PT_PROXY to allow client side proxy use.  This
+   is the pyptlib portion of the fixes for #8956.  Patch by Yawning
+   Angel.
 
 
 Changes in version 0.0.5 - 2013-09-30
diff --git a/pyptlib/client_config.py b/pyptlib/client_config.py
index b7393fc..01584fe 100644
--- a/pyptlib/client_config.py
+++ b/pyptlib/client_config.py
@@ -50,7 +50,17 @@ class ClientConfig(Config):
 
     def getProxy(self):
         """
+        Get the proxy that should be used for outgoing connections if any.
+
+        The returned urlparse.SplitResult has the following attributes:
+         * scheme - one of 'socks4a', 'socks5', or 'https'
+         * hostname - Hostname of the proxy
+         * port - TCP port of the proxy
+         * username - Username to use for proxy authentication (optional)
+         * password - Password to use for proxy authentication (optional)
+
         :returns: :attr:`pyptlib.client_config.ClientConfig.proxy`
+
         """
         return self.proxy
 

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