From 159ec00ea3b53d5f07b450b5f1cf0fda7faab685 Mon Sep 17 00:00:00 2001 From: Alvaro Bartolome Date: Sun, 13 Jun 2021 13:46:40 +0200 Subject: [PATCH] minor changes & included github discussions ref in docs --- README.md | 12 +++++++++++- docs/source/_info/{faq.md => discussions.md} | 19 +++++++++++++++++-- docs/source/index.rst | 2 +- 3 files changed, 29 insertions(+), 4 deletions(-) rename docs/source/_info/{faq.md => discussions.md} (66%) diff --git a/README.md b/README.md index 9b50f26..68584e6 100644 --- 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 b/docs/source/_info/discussions.md similarity index 66% rename from docs/source/_info/faq.md rename to docs/source/_info/discussions.md index 2a83053..69123a4 100644 --- a/docs/source/_info/faq.md +++ b/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 index 0825892..3b43873 100644 --- 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