From f5d6bc848cfb64b8f8db23c155c3dcaef24e31a5 Mon Sep 17 00:00:00 2001
From: Rossen Georgiev <rossen@rgp.io>
Date: Wed, 22 Jul 2015 10:38:48 +0100
Subject: [PATCH] WebAPI: moved doc() to __doc__; doc() now prints

---
 README.rst      |  9 ++++++---
 steam/webapi.py | 13 +++++++++++++
 2 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index 4afad08..4194572 100644
--- a/README.rst
+++ b/README.rst
@@ -38,7 +38,7 @@ The response will be deserialized using the appropriate module unless ``raw`` is
 
 .. code:: python
 
-    >>> print api.ISteamUser.ResolveVanityURL.doc()  # method doc
+    >>> api.ISteamUser.ResolveVanityURL.__doc__  # method doc
     """
     ResolveVanityURL (v0001)
 
@@ -51,8 +51,11 @@ The response will be deserialized using the appropriate module unless ``raw`` is
           - The vanity URL to get a SteamID for
 
     """
-    >>> print api.ISteamUser.doc()  # interface and all methods
-    >>> print api.doc()  # all available interfaces
+
+    # or calling doc() will print it
+    >>> api.ISteamUser.ResolveVanityURL.doc()  # method doc
+    >>> api.ISteamUser.doc()  # interface and all methods
+    >>> api.doc()  # all available interfaces
 
 
 Checkout the wiki for a `list of the currently available API interfaces`_.
diff --git a/steam/webapi.py b/steam/webapi.py
index ef29d01..2ab0566 100644
--- a/steam/webapi.py
+++ b/steam/webapi.py
@@ -1,3 +1,4 @@
+from __future__ import print_function
 import requests
 
 
@@ -124,6 +125,10 @@ class WebAPI(object):
             return vdf.load(resp.raw)
 
     def doc(self):
+        print(self.__doc__)
+
+    @property
+    def __doc__(self):
         doc = "Steam Web API - List of all interfaces\n\n"
         for interface in self.interfaces:
             doc += interface.doc()
@@ -167,6 +172,10 @@ class WebAPIInterface(object):
         return self._parent.https
 
     def doc(self):
+        print(self.__doc__)
+
+    @property
+    def __doc__(self):
         doc = "%s\n%s\n" % (self.name, '-'*len(self.name))
         for method in self.methods:
             doc += "  %s\n" % method.doc().replace("\n", "\n  ")
@@ -276,6 +285,10 @@ class WebAPIMethod(object):
         return self._parent.https
 
     def doc(self):
+        print(self.__doc__)
+
+    @property
+    def __doc__(self):
         doc = "%(httpmethod)s %(name)s (v%(version)04d)\n" % self._dict
 
         if 'description' in self._dict: