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

[docs] removed -s flag from documentation #2379

Merged
merged 1 commit into from
Aug 22, 2022

Conversation

boyestrous
Copy link
Contributor

Website documentation fixes:

  1. -s does not exist for stocks/options, must use --source

  2. per data_sources_default.json, fixed incorrect references to sources in the options module:
    -tr must be full name: tradier
    -ce must be full name: chartexchange

  3. Whitespace removal (end of line, etc.)

Functions and --help information are already correct, we just needed to correct the website docs

Description

  • Summary of the change / bug fix.
  • Link # issue, if applicable. [Bug] Short version of source flag ('-s') cannot be interpreted #2378
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
    • docs don't match actual behavior (difficult for new users)
    • Tradier no longer offers developer-only licenses, brokerage accounts are required, so Yahoo finance may be a preference
  • List any dependencies that are required for this change.
    • none

How has this been tested?

  • Please describe the tests that you ran to verify your changes.
    • viewed the relevant markdown files in github after pushing to my fork
  • Provide instructions so we can reproduce.
  • Please also list any relevant details for your test configuration.

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/....

Website documentation fixes:

1. -s does not exist for options, must use --source

2. per data_sources_default.json, fixed incorrect references to sources in options module:
-'tr'  must be full name: 'tradier'
-'ce must be full name: 'chartexchange'

Functions and --help information are already correct, we just needed to correct the website docs
@boyestrous boyestrous marked this pull request as ready for review August 20, 2022 18:16
@DidierRLopes DidierRLopes added the docs Code documentation label Aug 21, 2022
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.

Nice one! Thanks! 😀

@DidierRLopes DidierRLopes merged commit ae2b140 into OpenBB-finance:main Aug 22, 2022
@boyestrous boyestrous deleted the docs_update branch August 23, 2022 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants