Enhance docs for run.
Reviewed in https://codereview.appspot.com/6753051/.
diff --git a/oauth2client/tools.py b/oauth2client/tools.py
index 1faa9ff..37bf27d 100644
--- a/oauth2client/tools.py
+++ b/oauth2client/tools.py
@@ -96,6 +96,34 @@
def run(flow, storage, http=None):
"""Core code for a command-line application.
+ The run() function is called from your application and runs through all the
+ steps to obtain credentials. It takes a Flow argument and attempts to open an
+ authorization server page in the user's default web browser. The server asks
+ the user to grant your application access to the user's data. If the user
+ grants access, the run() function returns new credentials. The new credentials
+ are also stored in the Storage argument, which updates the file associated
+ with the Storage object.
+
+ It presumes it is run from a command-line application and supports the
+ following flags:
+
+ --[no]auth_local_webserver
+
+ Run a local web server to handle redirects during OAuth authorization.
+
+ --auth_host_name
+
+ Host name to use when running a local web server to handle redirects
+ during OAuth authorization.
+
+ --auth_host_port
+
+ Port to use when running a local web server to handle redirects during
+ OAuth authorization.
+
+ Since it uses flags make sure to initialize the gflags module before calling
+ run().
+
Args:
flow: Flow, an OAuth 2.0 Flow to step through.
storage: Storage, a Storage to store the credential in.