updating documentation

josuebrunel · Aug 21, 2015 · d6f0878 · d6f0878
1 parent d065e10
commit d6f0878
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ The response format is by default ***json***.
 >>> import myql
 >>> from myql.utils import pretty_json, pretty_xml
 >>> yql = myql.MYQL(format='xml', community=True)
->>> resp = yql.rawQuery('select name, woeid from geo.states where place="Congo"')
+>>> resp = yql.raw_query('select name, woeid from geo.states where place="Congo"')
 >>> print(pretty_xml(resp.content))
 <?xml version="1.0" encoding="utf-8"?>
 <query xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:count="11" yahoo:created="2015-06-07T11:56:11Z" yahoo:lang="en-US">
@@ -113,7 +113,7 @@ The response format is by default ***json***.
 <!-- total: 33 -->
 <!-- pprd1-node1003-lh3.manhattan.bf1.yahoo.com -->
 
->>> resp = yql.rawQuery('select name, woeid from geo.states where place="Congo"', format='json')
+>>> resp = yql.raw_query('select name, woeid from geo.states where place="Congo"', format='json')
 >>> print(pretty_json(resp.content))
 {
     "query": {
@@ -245,12 +245,12 @@ Returns table description
 >>>
 ```
 
-####rawQuery(query)
+####raw_query(query)
 
 Allows you to directly type your query
 
 ```python
->>> response = yql.rawQuery("select * from geo.countries where place='North America'")
+>>> response = yql.raw_query("select * from geo.countries where place='North America'")
 >>> # deal with the response
 ```
 
@@ -399,7 +399,7 @@ Delete records
 >>> oauth = OAuth1(None, None, from_file='credentials.json') # only consumer_key and consumer_secret are required.
 >>> from myql import MYQL
 >>> yql = MYQL(format='xml', oauth=oauth)
->>> response = yql.getGUID('josue_brunel') # Deal with the response
+>>> response = yql.get_guid('josue_brunel') # Deal with the response
 ```
 
 #### Stocks Scraper

diff --git a/README.rst b/README.rst
@@ -63,13 +63,13 @@ Disable access to community tables
 
 .. code:: python
 
-    >>> rep = yql.rawQuery('desc yahoo.finance.quotes ')
+    >>> rep = yql.raw_query('desc yahoo.finance.quotes ')
     >>> rep.json()
     {u'query': {u'count': 1, u'lang': u'en-US', u'results': {u'table': {u'src': u'http://www.datatables.org/yahoo/finance/yahoo.finance.quotes.xml', u'hash': u'061616a1c033ae89aaf2cbe83790b979', u'name': u'yahoo.finance.quotes', u'request': {u'select': {u'key': {u'required': u'true', u'type': u'xs:string', u'name': u'symbol'}}}, u'meta': {u'sampleQuery': u'\n\t\t\tselect * from yahoo.finance.quotes where symbol in ("YHOO","AAPL","GOOG","MSFT")\n\t\t'}, u'security': u'ANY'}}, u'created': u'2014-08-24T11:26:48Z'}}
     >>> 
     >>> yql.community= True # Setting up access to community
     >>> yql = myql.MYQL()
-    >>> rep = yql.rawQuery('desc yahoo.finance.quotes ')
+    >>> rep = yql.raw_query('desc yahoo.finance.quotes ')
     >>> rep.json()
     {u'error': {u'lang': u'en-US', u'description': u'No definition found for Table yahoo.finance.quotes'}}
 
@@ -90,10 +90,10 @@ The response format is by default ***json***.
 
     >>> import myql
     >>> yql = myql.MYQL(format='xml', community=True)
-    >>> rep = yql.rawQuery('select name, woeid from geo.states where place="Congo"')
+    >>> rep = yql.raw_query('select name, woeid from geo.states where place="Congo"')
     >>> rep.text
     u'<?xml version="1.0" encoding="UTF-8"?>\n<query xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:count="11" yahoo:created="2014-08-27T04:52:22Z" yahoo:lang="en-US"><results><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Cuvette-Ouest Department</name><woeid>55998384</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Cuvette Department</name><woeid>2344968</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Plateaux District</name><woeid>2344973</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Sangha</name><woeid>2344974</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Lekoumou</name><woeid>2344970</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Pool Department</name><woeid>2344975</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Likouala Department</name><woeid>2344971</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Niari Department</name><woeid>2344972</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Brazzaville</name><woeid>2344976</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Bouenza Department</name><woeid>2344967</woeid></place><place xmlns="http://where.yahooapis.com/v1/schema.rng"><name>Kouilou</name><woeid>2344969</woeid></place></results></query><!-- total: 19 -->\n<!-- engine7.yql.bf1.yahoo.com -->\n'
-    >>> rep = yql.rawQuery('select name, woeid from geo.states where place="Congo"', format='json')
+    >>> rep = yql.raw_query('select name, woeid from geo.states where place="Congo"', format='json')
     >>> rep.json()
     {u'query': {u'count': 11, u'lang': u'en-US', u'results': {u'place': [{u'woeid': u'55998384', u'name': u'Cuvette-Ouest Department'}, {u'woeid': u'2344968', u'name': u'Cuvette Department'}, {u'woeid': u'2344973', u'name': u'Plateaux District'}, {u'woeid': u'2344974', u'name': u'Sangha'}, {u'woeid': u'2344970', u'name': u'Lekoumou'}, {u'woeid': u'2344975', u'name': u'Pool Department'}, {u'woeid': u'2344971', u'name': u'Likouala Department'}, {u'woeid': u'2344972', u'name': u'Niari Department'}, {u'woeid': u'2344976', u'name': u'Brazzaville'}, {u'woeid': u'2344967', u'name': u'Bouenza Department'}, {u'woeid': u'2344969', u'name': u'Kouilou'}]}, u'created': u'2014-08-27T04:52:38Z'}}
     >>>
@@ -122,14 +122,14 @@ Returns table description
     {u'query': {u'count': 1, u'lang': u'en-US', u'results': {u'table': {u'request': {u'select': [{u'key': [{u'required': u'true', u'type': u'xs:string', u'name': u'location'}, {u'type': u'xs:string', u'name': u'u'}]}, {u'key': [{u'required': u'true', u'type': u'xs:string', u'name': u'woeid'}, {u'type': u'xs:string', u'name': u'u'}]}]}, u'security': u'ANY', u'meta': {u'documentationURL': u'http://developer.yahoo.com/weather/', u'sampleQuery': u'select * from weather.forecast where woeid=2502265', u'description': u'Weather forecast table', u'author': u'Yahoo! Inc'}, u'hash': u'aae78b1462a6a8fbc748aec4cf292767', u'name': u'weather.forecast'}}, u'created': u'2014-08-16T19:31:51Z'}}
     >>>
 
-rawQuery(query)
+raw_query(query)
 ^^^^^^^^^^^^^^^
 
 Allows you to directly type your query
 
 .. code:: python
 
-    >>> response = yql.rawQuery("select * from geo.countries where place='North America'")
+    >>> response = yql.raw_query("select * from geo.countries where place='North America'")
     >>> # deal with the response
 
 select(table, fields, limit).where(filters, ...)

diff --git a/docs/index.md b/docs/index.md
@@ -39,7 +39,7 @@ The response format is by default ***json***.
 >>> import myql
 >>> from myql.utils import pretty_json, pretty_xml
 >>> yql = myql.MYQL(format='xml', community=True)
->>> resp = yql.rawQuery('select name, woeid from geo.states where place="Congo"')
+>>> resp = yql.raw_query('select name, woeid from geo.states where place="Congo"')
 >>> print(pretty_xml(resp.content))
 <?xml version="1.0" encoding="utf-8"?>
 <query xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:count="11" yahoo:created="2015-06-07T11:56:11Z" yahoo:lang="en-US">
@@ -93,7 +93,7 @@ The response format is by default ***json***.
 <!-- total: 33 -->
 <!-- pprd1-node1003-lh3.manhattan.bf1.yahoo.com -->
 
->>> resp = yql.rawQuery('select name, woeid from geo.states where place="Congo"', format='json')
+>>> resp = yql.raw_query('select name, woeid from geo.states where place="Congo"', format='json')
 >>> print(pretty_json(resp.content))
 {
     "query": {
@@ -230,7 +230,7 @@ Returns table description
 Allows you to directly type your query
 
 ```python
->>> response = yql.rawQuery("select * from geo.countries where place='North America'")
+>>> response = yql.raw_query("select * from geo.countries where place='North America'")
 >>> # deal with the response
 ```
 
@@ -379,7 +379,7 @@ Delete records
 >>> oauth = OAuth1(None, None, from_file='credentials.json') # only consumer_key and consumer_secret are required.
 >>> from myql import MYQL
 >>> yql = MYQL(format='xml', oauth=oauth)
->>> response = yql.getGUID('josue_brunel') # Deal with the response
+>>> response = yql.get_guid('josue_brunel') # Deal with the response
 ```
 
 ## Utils