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

Display the help menu whenever users move to a different menu #1968

Merged
merged 15 commits into from
Jun 22, 2022

Conversation

montezdesousa
Copy link
Contributor

Description

As the title suggests the point of this PR is just to display the help menu when users move to a new menu either going forward or back. This might help avoiding users feeling lost when they return to previous menus and nothing is displayed.

My suggestion is just to put feature flag OPENBB_ENABLE_EXIT_AUTO_HELP as True by default. Also changed the call_home function to print help in the case home is called from root already. This way the behavior of home command is consistent whether it is called from root or from any other context.

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.

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

@montezdesousa montezdesousa added the enhancement Enhancement label Jun 21, 2022
@montezdesousa montezdesousa marked this pull request as ready for review June 21, 2022 10:49
Copy link
Contributor

@Chavithra Chavithra left a comment

Choose a reason for hiding this comment

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

Looks all good on my side !

@montezdesousa montezdesousa added the do not merge Label to prevent pull request merge label Jun 21, 2022
@minhhoang1023
Copy link
Contributor

Tested for the following edge cases and it's working well :)

  • Call the menu using paths such as ../../stocks
    image

  • Tested with routines - there should not be any help menu printed to avoid noise.
    image

Well done for the idea & quick implementation!

@montezdesousa montezdesousa added do not merge Label to prevent pull request merge and removed do not merge Label to prevent pull request merge labels Jun 22, 2022
@montezdesousa montezdesousa removed the do not merge Label to prevent pull request merge label Jun 22, 2022
@montezdesousa montezdesousa merged commit 57b61d1 into main Jun 22, 2022
@Chavithra Chavithra deleted the gstdev868 branch June 22, 2022 12:58
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.

3 participants