Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add keys examples in docstrings #3497

Merged
merged 10 commits into from
Nov 21, 2022
Merged

Add keys examples in docstrings #3497

merged 10 commits into from
Nov 21, 2022

Conversation

montezdesousa
Copy link
Contributor

Description

  • This PR add examples in docstring to the SDK keys endpoints
  • Summary of the change / bug fix.
  • Link # issue, if applicable.
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
  • List any dependencies that are required for this change.

How has this been tested?

  • Please describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • Please also list any relevant details for your test configuration.
  • Make sure affected commands still run in terminal
  • Ensure the SDK still works
  • Check any related reports

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.

@reviewpad reviewpad bot added the feat M Medium T-Shirt size feature label Nov 21, 2022
@montezdesousa montezdesousa added platform OpenBB Platform docs Code documentation labels Nov 21, 2022
@montezdesousa montezdesousa marked this pull request as ready for review November 21, 2022 11:07
jmaslek
jmaslek approved these changes Nov 21, 2022
View reviewed changes
openbb_terminal/miscellaneous/library/trail_map.csv Outdated
@@ -518,7 +518,7 @@ keys.fmp,openbb_terminal.keys_model.set_fmp_key,
keys.quandl,openbb_terminal.keys_model.set_quandl_key,
keys.polygon,openbb_terminal.keys_model.set_polygon_key,
keys.fred,openbb_terminal.keys_model.set_fred_key,
keys.news,openbb_terminal.keys_model.set_news_key,
keys.news,openbb_terminal.keys_model.set_news_kPey,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this intentional ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nop, fixed minutes ago

simmonsj330
simmonsj330 approved these changes Nov 21, 2022
View reviewed changes
Copy link
Contributor

@simmonsj330 simmonsj330 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@montezdesousa montezdesousa merged commit 659c214 into main Nov 21, 2022
@montezdesousa montezdesousa deleted the key_doc branch November 21, 2022 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simmonsj330 simmonsj330 simmonsj330 approved these changes

@jmaslek jmaslek jmaslek approved these changes

Assignees
No one assigned
Labels
docs Code documentation feat M Medium T-Shirt size feature platform OpenBB Platform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@montezdesousa @jmaslek @simmonsj330