Peer review feedbacks

[sirine-chahma]

Feedbacks from Carlina :

To do :

• [x] specify in the documentation that the API key must be a string
• [x] Example in the gather_financial_statement_company_compare() function didn't work when the tickers were AAPL and CSCO, take a look at this
• [x] Move the description of the functions before the examples in the README
• [x] Add a list of the possible tickers in the README (at least the ones that are accessible for everybody)

To do if we have time :

• [ ] Have a list with the definition of some tickers (AAPL, CSCO,...)
• [ ] Add test to check if the API is a string and return a meaningful message if not

[sirine-chahma]

For this point : Have a list with the definition of some tickers (AAPL, CSCO,...) I don't think it is not necessary as the people who will use our package and know Intrinio will already know what those tickers mean.

[sirine-chahma]

For this point : Add test to check if the API is a string and return a meaningful message if not I tried to adress it, but I have the feeling it is not possible because as soon as I try to use the api key without quotation marks, it throws an error because this object doesn't exist. I think the error that is thrown has a message that is meaningful enough : object api_key not found . Moreover, we specified in the docstrings of our functions that the api_key must be a character.