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

Second attempt to fix search on docs #5832

Merged
merged 1 commit into from
Nov 30, 2023
Merged

Second attempt to fix search on docs #5832

merged 1 commit into from
Nov 30, 2023

Conversation

jose-donato
Copy link
Contributor

Pull Request OpenBB

The OpenBBTerminal

Pull Request for the OpenBBTerminal

Description

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

  • Please provide instructions so we can reproduce.

  • Please also list any relevant details for your test configuration.

  • Ensure the affected commands still execute in the OpenBB Terminal.

  • Ensure the Platform (previously named SDK) is working as intended.

  • Check any related reports.

Checklist

  • I ensure I have self-reviewed my code.
  • I have commented/documented my code, particularly in hard-to-understand sections.
  • I have adhered to the GitFlow naming convention and my branch name is in the format of feature/feature-name or hotfix/hotfix-name.
  • Update our documentation following these guidelines. Update any user guides that are affected by the changes.
  • Update our tests following these guidelines.
  • Make sure you are following our CONTRIBUTING guidelines.
  • If a feature was added make sure to add it to the corresponding integration test script.

The OpenBB Platform

Pull Request for the OpenBB Platform

Description

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

  • Please provide instructions so we can reproduce.

  • Please also list any relevant details for your test configuration.

  • Ensure all unit and integration tests pass.

  • If you modified/added command(s):

    • Ensure the command(s) execute with the expected output.
      • API.
      • Python Interface.
    • If applicable, please add new tests for the command (see CONTRIBUTING.md to leverage semi-automated testing).
  • If a new provider was introduced or a new fetcher was added to an existing provider:

    • Ensure the existing tests pass.
    • Ensure the new provider and/or fetcher is stable and usable.
    • If applicable, please add new tests for the provider and/or fetcher (see CONTRIBUTING.md to leverage semi-automated testing).
  • If a new provider or extension was added:

Checklist

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have adhered to the GitFlow naming convention and my branch name is in the format of feature/feature-name or hotfix/hotfix-name.
  • I ensure that I am following th CONTRIBUTING guidelines.

@piiq piiq added the docs Code documentation label Nov 30, 2023
@piiq piiq added this pull request to the merge queue Nov 30, 2023
Merged via the queue into develop with commit 5e92623 Nov 30, 2023
12 of 13 checks passed
@piiq piiq deleted the docs/attempt_search_2 branch December 3, 2023 16:02
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.

None yet

3 participants