Commits

Dusty Phillips committed ed94bc0

Minor documentation tweaks.

Comments (0)

Files changed (7)

 class AstridAPI(object):
     '''Connect to the Astrid Tasks API and issue requests to a specific
     user's account.
+
+    Python Astrid API lives at https://bitbucket.org/dusty/python-astrid/
+    and documentation is available at https://python-astrid.readthedocs.org/
     '''
 
     def __init__(self, conf):
         '''
-        :param conf: a dictionary  of configuration values
+        :param conf: a dictionary of configuration values
+            for connecting to the API.
 
         The conf dictionary must contain::
 
             raise AttributeError("Unable to sign into astrid. Ensure your "
                 "api key, api secret, email, and password are correct.")
 
-    def send_request(self, method, **params):
+    def request(self, method, **params):
         '''Send a request to the astrid API.
         The available methods and their parameters are described in
         http://astrid.com/apidoc/ApiController.html

docs/_build/doctrees/environment.pickle

Binary file modified.

docs/_build/doctrees/index.doctree

Binary file modified.

docs/_build/html/genindex.html

 
 <div class="genindex-jumpbox">
  <a href="#A"><strong>A</strong></a>
- | <a href="#S"><strong>S</strong></a>
+ | <a href="#R"><strong>R</strong></a>
  
 </div>
 <h2 id="A">A</h2>
   </dl></td>
 </tr></table>
 
-<h2 id="S">S</h2>
+<h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
       
-  <dt><a href="index.html#astrid.AstridAPI.send_request">send_request() (astrid.AstridAPI method)</a>
+  <dt><a href="index.html#astrid.AstridAPI.request">request() (astrid.AstridAPI method)</a>
   </dt>
 
   </dl></td>

docs/_build/html/index.html

 <em class="property">class </em><tt class="descclassname">astrid.</tt><tt class="descname">AstridAPI</tt><big>(</big><em>conf</em><big>)</big><a class="reference internal" href="_modules/astrid.html#AstridAPI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astrid.AstridAPI" title="Permalink to this definition">¶</a></dt>
 <dd><p>Connect to the Astrid Tasks API and issue requests to a specific
 user&#8217;s account.</p>
+<p>Python Astrid API lives at <a class="reference external" href="https://bitbucket.org/dusty/python-astrid/">https://bitbucket.org/dusty/python-astrid/</a>
+and documentation is available at <a class="reference external" href="https://python-astrid.readthedocs.org/">https://python-astrid.readthedocs.org/</a></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>conf</strong> &#8211; a dictionary  of configuration values</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>conf</strong> &#8211; a dictionary  of configuration values
+for connecting to the API.</td>
 </tr>
 </tbody>
 </table>
 is stored on the class and automatically sent
 with future requests.</p>
 <dl class="method">
-<dt id="astrid.AstridAPI.send_request">
-<tt class="descname">send_request</tt><big>(</big><em>method</em>, <em>**params</em><big>)</big><a class="reference internal" href="_modules/astrid.html#AstridAPI.send_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astrid.AstridAPI.send_request" title="Permalink to this definition">¶</a></dt>
+<dt id="astrid.AstridAPI.request">
+<tt class="descname">request</tt><big>(</big><em>method</em>, <em>**params</em><big>)</big><a class="headerlink" href="#astrid.AstridAPI.request" title="Permalink to this definition">¶</a></dt>
 <dd><p>Send a request to the astrid API.
 The available methods and their parameters are described in
 <a class="reference external" href="http://astrid.com/apidoc/ApiController.html">http://astrid.com/apidoc/ApiController.html</a></p>

docs/_build/html/objects.inv

File contents unchanged.

docs/_build/html/searchindex.js

-Search.setIndex({objects:{"":{astrid:[0,0,1,""]},astrid:{AstridAPI:[0,1,1,""]},"astrid.AstridAPI":{send_request:[0,2,1,""]}},terms:{configur:0,astridapi:0,creat:0,signatur:0,send_request:0,request:0,argument:0,automat:0,sign:0,expect:0,api:0,connect:0,conf:0,respons:0,http:0,apidoc:0,your:0,paramet:0,issu:0,astrid:0,from:0,welcom:0,receiv:0,come:0,api_kei:0,apisecret:0,param:0,content:0,method:0,secret:0,html:0,decod:0,futur:0,avail:0,call:0,you:0,document:0,type:0,email:0,sent:0,can:0,map:0,sourc:0,"return":0,kei:0,format:0,python:0,json:0,send:0,user:0,dictionari:0,mail:0,line:0,password:0,associ:0,"class":0,valu:0,must:0,account:0,task:0,name:0,keyword:0,provid:0,apikei:0,specif:0,work:0,requir:0,doe:0,signin:0,describ:0,exampl:0,necessari:0,store:0,thi:0,contain:0,com:0,apicontrol:0,token:0,dict:0},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Welcome to Astrid Python API&#8217;s documentation!"],objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},filenames:["index"]})
+Search.setIndex({objects:{"":{astrid:[0,0,1,""]},astrid:{AstridAPI:[0,2,1,""]},"astrid.AstridAPI":{request:[0,1,1,""]}},terms:{api_kei:0,astridapi:0,creat:0,map:0,send_request:[],secret:0,argument:0,automat:0,sign:0,api:0,connect:0,conf:0,respons:0,"return":0,doe:0,apidoc:0,your:0,paramet:0,avail:0,password:0,from:0,describ:0,receiv:0,associ:0,configur:0,apisecret:0,param:0,content:0,live:0,html:0,decod:0,futur:0,contain:0,call:0,you:0,document:0,type:0,email:0,store:0,signin:0,signatur:0,sourc:0,http:0,kei:0,format:0,python:0,exampl:0,json:0,account:0,dict:0,user:0,dictionari:0,mail:0,org:0,line:0,astrid:0,come:0,"class":0,valu:0,welcom:0,requir:0,bitbucket:0,task:0,name:0,keyword:0,provid:0,apikei:0,specif:0,work:0,request:0,method:0,issu:0,token:0,must:0,necessari:0,can:0,thi:0,sent:0,dusti:0,readthedoc:0,com:0,apicontrol:0,send:0,expect:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["Welcome to Astrid Python API&#8217;s documentation!"],objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"]},filenames:["index"]})