From 416667adfb4a3a49ce4c3f2155b1d220d3d8158b Mon Sep 17 00:00:00 2001
From: Linus E <75929322+Rripped@users.noreply.github.com>
Date: Tue, 15 Mar 2022 14:43:05 +0100
Subject: [PATCH] added function descriptions

---
 telegram_bot/news_fetcher.py | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/telegram_bot/news_fetcher.py b/telegram_bot/news_fetcher.py
index 65af5b5..836b2fe 100644
--- a/telegram_bot/news_fetcher.py
+++ b/telegram_bot/news_fetcher.py
@@ -20,20 +20,30 @@ load_dotenv()
 # Init
 newsapi = NewsApiClient(api_key=os.getenv('NEWS_API_KEY'))
 
-# /v2/top-headlines
-top_headlines = newsapi.get_top_headlines(q='bitcoin', sources='bbc-news,the-verge', language='en')
-
-# /v2/everything
-all_articles = newsapi.get_everything(q='bitcoin', sources='bbc-news,the-verge', domains='bbc.co.uk,techcrunch.com', from_param='2022-03-14', to='2022-03-15', language='en', sort_by='relevancy', page=2)
 
 # /v2/top-headlines/sources
 sources = newsapi.get_sources()
 
 def get_top_news_by_keyword(keyword):
+    """get top news to keyword
+    Args:
+        keyword (String): keyword for search
+
+    Returns:
+        JSON/dict: dict containing articles
+    """    
     top_headlines = newsapi.get_top_headlines(q=keyword, sources='bbc-news,the-verge,cnn', language='en')
     return top_headlines
 
 def format_article(article):
+    """format article for messaging (using markdown syntax)
+
+    Args:
+        article (dict): article to format for messaging
+
+    Returns:
+        String: formatted article
+    """    
     sourcename = article["source"]["name"]
     headline = article["title"]
     url = article["url"]