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.

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

added wiki command #2492

Merged
merged 11 commits into from
Sep 6, 2022
Merged

added wiki command #2492

merged 11 commits into from
Sep 6, 2022

Conversation

hjoaquim
Copy link
Contributor

@hjoaquim hjoaquim commented Sep 4, 2022

Description

  • Summary of the change / bug fix.
    Added wiki command -> type wiki and find a simple title/url/summary for any expression (from the wikipedia)

  • Screenshot of the feature or the bug before/after fix, if applicable.
    image

another one, using the "-e":

image

  • Relevant motivation and context.
    It's hard for average users/ users with no financial education to keep up with all the jargons we use on the terminal

How has this been tested?

  • Provide instructions so we can reproduce.
    type "wiki -e EXPRESSIONS" or "wiki EXPRESSIONS" from anywhere

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My code passes all the checks pylint, flake8, black, ... To speed up development you should run pre-commit install.
  • New and existing unit tests pass locally with my changes. You can test this locally using pytest tests/....

@hjoaquim hjoaquim added the feat XS Extra small feature label Sep 4, 2022
@hjoaquim
Copy link
Contributor Author

hjoaquim commented Sep 4, 2022

@DidierRLopes thought it would be really cool to have some kind of glossary on the terminal - leveraging the Wikipedia API would allow users to search for virtually anything if they have doubts regarding the meaning of something while using the terminal without leaving (and even pursue more info through the URL if wanted)
What are your thoughts on this?

Copy link
Contributor

@colin99d colin99d left a comment

Choose a reason for hiding this comment

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

Great work! I am proud of you.

@colin99d colin99d marked this pull request as ready for review September 4, 2022 11:11
Copy link
Collaborator

@DidierRLopes DidierRLopes left a comment

Choose a reason for hiding this comment

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

Couple of comments, but very nice addition!!

terminal.py Outdated Show resolved Hide resolved
openbb_terminal/helper_funcs.py Outdated Show resolved Hide resolved
@hjoaquim hjoaquim merged commit a8c9b4e into OpenBB-finance:main Sep 6, 2022
@hjoaquim hjoaquim deleted the wiki branch September 6, 2022 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat XS Extra small feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants