minor changes & included github discussions ref in docs

alvarobartt · Jun 13, 2021 · 159ec00 · 159ec00
1 parent 05c99c9
commit 159ec00
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -107,7 +107,9 @@ Retrieved search results will be a `list` of `investpy.utils.search_obj.SearchOb
 To get to know which are the available functions and attributes of the returned search results, please read the related 
 documentation at [Search Engine Documentation](https://investpy.readthedocs.io/search_api.html). So on, those 
 search results let the user retrieve both recent and historical data, its information, the technical indicators,
-the default currency, etc., as presented in the piece of code below:
+the default currency, etc., as presented in the pieces of code below:
+
+#### Recent Data
 
 ```python
 recent_data = search_result.retrieve_recent_data()
@@ -124,6 +126,8 @@ Date
 
 ```
 
+#### Historical Data
+
 ```python
 historical_data = search_result.retrieve_historical_data(from_date='01/01/2019', to_date='01/01/2020')
 print(historical_data.head())
@@ -139,6 +143,8 @@ Date
 
 ```
 
+#### Information
+
 ```python
 information = search_result.retrieve_information()
 print(information)
@@ -148,6 +154,8 @@ print(information)
 
 ```
 
+#### Currency
+
 ```python
 default_currency = search_result.retrieve_currency()
 print(default_currency)
@@ -157,6 +165,8 @@ print(default_currency)
 
 ```
 
+#### Technical Indicators
+
 ```python
 technical_indicators = search_result.retrieve_technical_indicators(interval='daily')
 print(technical_indicators)

diff --git a/docs/source/_info/faq.md → docs/source/_info/discussions.md b/docs/source/_info/faq.md → docs/source/_info/discussions.md
@@ -1,6 +1,21 @@
-# ❓ Frequent Asked Questions - FAQs
+# ❓ Discussions (Q&A, AMA)
 
-In this section the Frequent Asked Questions are answered, so please read this section before posting a question or openning an issue since duplicates will not be solved or will be referenced to this section. Also, if you think that there are more possible FAQs, consider openning an issue in GitHub so to notify it, since if we all contribute this section can be clear enough so to ease question answering.
+GitHub recently released a new feature named __GitHub Discussions__ (still in beta). GitHub Discussions is a 
+collaborative communication forum for the community around an open source project.
+
+Check the investpy GitHub Discussions page at [Discussions](https://github.com/alvarobartt/investpy/discussions), 
+and feel free to ask me (ar any developer) anything, share updates, have open-ended conversations, and follow along 
+on decisions affecting the community's way of working.
+
+:pushpin: __Note__. Usually I don't answer emails asking me questions about investpy, as we currently have the
+GitHub Discussions tab, and I encourage you to use it. GitHub Discussions is the easiest way to contact me about 
+investpy, so that I don't answer the same stuff more than once via email, as anyone can see the opened/answered
+discussions.
+
+Also, in this section some Frequent Asked Questions are answered, so please read this section before posting a 
+question or openning an issue since duplicates will not be solved or will be referenced to this section. Also, 
+if you think that there are more possible FAQs, consider openning an issue in GitHub so to notify it, since if we 
+all contribute this section can be clear enough so to ease question answering.
 
 ## Where can I find the reference of a function and its usage?
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,7 +14,7 @@ Welcome to investpy's documentation!
    _info/related_projects.md
    _info/contact_information.md
    _info/citation.md
-   _info/faq.md
+   _info/discussions.md
    _info/disclaimer.md
    api.rst