Merge pull request #81 from guptaaastha/utility-comments

Add comments to utility.py file #81

Author: GouravSardana

src/arguments/utility.py

@@ -32,6 +32,11 @@ def __init__(self):
         self.search_content_url = "https://api.stackexchange.com/"
 
     def __get_search_url(self, question, tags):
+        """
+        This function returns the url that contains all the custom
+        data provided by the user such as tags and question, which
+        can finally be used to get answers
+        """
         return f"{self.search_content_url}/2.2/search/advanced?order=desc&sort=relevance&tagged={tags}&title={question}&site=stackoverflow"
 
     def make_request(self, que, tag: str):
@@ -54,13 +59,32 @@ def make_request(self, que, tag: str):
         return resp.json()
 
     def get_que(self, json_data):
+        """
+        This function returns the list of ids of the questions
+        that have been answered, from the response that we get
+        from the make_request function.
+        """
         que_id = []
         for data in json_data['items']:
             if data["is_answered"]:
                 que_id.append(data["question_id"])
         return que_id
 
     def get_ans(self, questions_list):
+        """
+        This function prints the answer to the queries
+        (question and tags) provided by the user. It does so
+        in the following manner :
+
+        1) Takes in account only th first question id from the
+        list of question ids
+
+        2) Tries to get a response from the url obtained by appending
+        question id to the search_content_url variable
+
+        3) Use the data received from the above request and loop
+        through it to print the answer
+        """
         ans = []
         for questions in range(1):
             try:
@@ -83,7 +107,7 @@ def get_ans(self, questions_list):
                 for output_index, output_text in enumerate(output_content):
                     """
                     Loop through the output_text and print the element
-                    if it the last one, the text[0] is printed
+                    if it is the last one, the text[0] is printed
                     along with text[-1]
 
                     if text is markdown , render the markdown