From 720f33fb5ee9667e995ba2d0d800a7c14316893d Mon Sep 17 00:00:00 2001 From: josuebrunel Date: Wed, 8 Jul 2015 11:09:04 +0200 Subject: [PATCH] #1: updating docs --- docs/stockscraper.md | 24 ++++++++++++++++++++++++ docs/weather.md | 25 ++++++++----------------- 2 files changed, 32 insertions(+), 17 deletions(-) diff --git a/docs/stockscraper.md b/docs/stockscraper.md index a326af0..bcf96af 100644 --- a/docs/stockscraper.md +++ b/docs/stockscraper.md @@ -460,6 +460,30 @@ data = stocks.get_dividendhistory('AAPL',"2008-01-01", "2015-06-15") ``` +#### *StockRetriever.get_balancesheet(symbol)* + +```python +from myql.contrib.finance.stockscraper import StockRetriever +stocks = StockRetriever(format='json') +data = self.stock.get_balancesheet('YHOO') +``` + +```json +{ + "query": { + "count": 1, + "created": "2015-07-08T09:01:12Z", + "lang": "en-US", + "results": { + "balancesheet": { + "symbol": "YHOO", + "timeframe": "quarterly" + } + } + } +} +``` + #### *StockRetriever.get_symbols(company_name)*      **Always returns data as JSON** diff --git a/docs/weather.md b/docs/weather.md index efef5c5..2c0dd81 100644 --- a/docs/weather.md +++ b/docs/weather.md @@ -9,8 +9,8 @@ Weater * ***kwargs*** : Any possible argument of **YQL** ```python ->>> from myql.contrib.weather import Weather ->>> weather = Weather(unit='c', format='json') +from myql.contrib.weather import Weather +weather = Weather(unit='c', format='json') ``` @@ -20,7 +20,7 @@ Weater >Return weather information according to the place passed in ```python ->>> data = weather.get_weather_in('choisy-le-roi', 'c',['location', 'units', 'item.condition']) +data = weather.get_weather_in('choisy-le-roi', 'c',['location', 'units', 'item.condition']) ``` ```json @@ -141,7 +141,7 @@ Weater >Return weather forecast ```python ->>> data = weather.get_weather_description('dolisie') +data = weather.get_weather_description('dolisie') ``` ```json @@ -164,20 +164,11 @@ Weater ``` -#### *Weather.get_current_condition(place)* ->get_current_condition - -```python -``` - -```json -``` - #### *Weather.get_current_atmosphere(place)* >Return weather atmosphere ```python ->>> data = weather.get_current_condition('Nantes') +data = weather.get_current_condition('Nantes') ``` ```json @@ -238,7 +229,7 @@ Weater >Return sunrise and sunset time ```python ->>> data = weather.get_current_atmosphere('Scotland') +data = weather.get_current_atmosphere('Scotland') ``` ```json @@ -340,7 +331,7 @@ Weater >Return weather wind ```python ->>> data = weather.get_current_wind('Barcelona') +data = weather.get_current_wind('Barcelona') ``` ```json @@ -411,7 +402,7 @@ Weater >Return sunrise and sunset time ```python ->>> data = weather.get_astronomy('Congo') +data = weather.get_astronomy('Congo') ``` ```json