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

[Feature] Improved cached results #6506

Merged
merged 11 commits into from
Jun 18, 2024
Merged

Conversation

hjoaquim
Copy link
Contributor

  1. Why? (1-3 sentences or a bullet point list):

    • Adds more flexibility to interact with the obtained results.
  2. What? (1-3 sentences or a bullet point list):

    • results → shows table with all the available results
    • results always on screen (number of results showing can be managed on settings)
    • using a key instead of the index:
      • historical --symbol aapl --register_key aapl-hist
      • ema --data aapl-hist
    • results --idx 0/--key my-key → displays the actual OBBject.results in a table
    • results --idx 0/--key my-key --chart → display the chart if available
    • choose which results to keep: historical --symbol aapl --register_obbject (the register_obbject flag means this result will be opted out, by default we keep the result)
  3. Impact (1-2 sentences or a bullet point list):

    • 5/40
Impact Analysis

UX: 3
Performance: 0
Compatibility: 0
Security: 0
Scalability: 1
Maintenance: 1
Compliance: 0
Dependency: 0

  1. Testing Done:

    • Any of the described above on the what section

@github-actions github-actions bot added the enhancement Enhancement label Jun 17, 2024
…inance/OpenBBTerminal into feature/improved-cached-results
@deeleeramone
Copy link
Contributor

  • choose which results to keep: historical --symbol aapl --register_obbject (the register_obbject flag means this result will be opted out, by default we keep the result)

This is a lot of keys to type every time (I understand auto complete exists, but still), can we shorten this, something like "--store"?, or "--keep"?

I find the name --register_obbject to be counter-intuitive for the action - "False". The name suggests the action would be, "True". Is there an inverse mode where I can keep only the flagged items?

@hjoaquim
Copy link
Contributor Author

  • choose which results to keep: historical --symbol aapl --register_obbject (the register_obbject flag means this result will be opted out, by default we keep the result)

This is a lot of keys to type every time (I understand auto complete exists, but still), can we shorten this, something like "--store"?, or "--keep"?

Given the fact that we have auto-completion, I believe verbosity adds clarity.

I find the name --register_obbject to be counter-intuitive for the action - "False". The name suggests the action would be, "True". Is there an inverse mode where I can keep only the flagged items?

I agree, but taking into consideration the default should be to keep it, what can we name it? Also, despite not being the best name, the message displayed on --help clarifies!

@hjoaquim hjoaquim added this pull request to the merge queue Jun 18, 2024
Merged via the queue into develop with commit fdfacc8 Jun 18, 2024
9 checks passed
@IgorWounds IgorWounds deleted the feature/improved-cached-results branch June 19, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants