From bd21c52900873313e4a508a6257a313372793ee8 Mon Sep 17 00:00:00 2001 From: dgnsrekt Date: Tue, 6 Oct 2020 18:43:44 -0500 Subject: [PATCH] docs: fixed the get_multiple_summary_pages example section. --- docs/.generated-files.txt | 2 +- docs/content/examples/summary-page-examples.md | 6 +++--- docs/markdown/summary_examples.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/.generated-files.txt b/docs/.generated-files.txt index 82e964c..8fdad25 100644 --- a/docs/.generated-files.txt +++ b/docs/.generated-files.txt @@ -1,6 +1,6 @@ md5 4deb21401513245e45fbac01d42e30f2 content/index.md md5 c5541b9bc62ed11325a343e0861c3da0 content/examples/fuzzy-search-examples.md -md5 f2953acdf551a4c84992bc1761132a66 content/examples/summary-page-examples.md +md5 7ed154d81f590361b8bdf6326fd1abc9 content/examples/summary-page-examples.md md5 59cc7c35f69ba3d194d9260e54d3aca4 content/examples/extra-watchlist-example.md md5 38e0a0b77bf834d4bc2facc5cc3a6696 content/api/asset-types-module.md md5 0e1de7b8e161c64751268734db188a8a content/api/cleaner-module.md diff --git a/docs/content/examples/summary-page-examples.md b/docs/content/examples/summary-page-examples.md index d2cd132..5660f31 100644 --- a/docs/content/examples/summary-page-examples.md +++ b/docs/content/examples/summary-page-examples.md @@ -10,7 +10,7 @@ print(result.json(indent=4)) ``` !!! note - Note: The get_summary_page function returns a single SummaryPage object. You can serialize the SummaryPage object to json or a dictionary with the .json() and .dict() methods. + The get_summary_page function returns a single SummaryPage object. You can serialize the SummaryPage object to json or a dictionary with the .json() and .dict() methods. ## How to get multiple quotes from the summary page. @@ -22,8 +22,8 @@ COLUMNS = ["open", "high", "low", "close", "volume"] search_items = ["TSLA", "GOOGLE", "appl", "aapl"] results = get_multiple_summary_pages(search_items) - print(results.dataframe[COLUMNS]) ``` + !!! note - Note: You can pass company names too. This function will do a symbol look up for you using fuzzy_search. The get_multiple_summary_pages returns a SummaryPageGroup which you can serialize to a pandas dataframe. + You can pass company names too. This function will do a symbol look up for you using fuzzy_search. The get_multiple_summary_pages returns a SummaryPageGroup which you can serialize to a pandas dataframe. diff --git a/docs/markdown/summary_examples.md b/docs/markdown/summary_examples.md index 111d2ab..5660f31 100644 --- a/docs/markdown/summary_examples.md +++ b/docs/markdown/summary_examples.md @@ -22,8 +22,8 @@ COLUMNS = ["open", "high", "low", "close", "volume"] search_items = ["TSLA", "GOOGLE", "appl", "aapl"] results = get_multiple_summary_pages(search_items) - print(results.dataframe[COLUMNS]) ``` + !!! note You can pass company names too. This function will do a symbol look up for you using fuzzy_search. The get_multiple_summary_pages returns a SummaryPageGroup which you can serialize to a pandas dataframe.