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.

Sign up for GitHub

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

Jump to bottom

adding basic instructions for the --export feature #3669

Merged
merged 9 commits into from
Dec 6, 2022
Merged

adding basic instructions for the --export feature #3669

merged 9 commits into from
Dec 6, 2022

Conversation

slateem
Copy link
Contributor

@slateem slateem commented Nov 30, 2022

I would like to propose adding some additional basic instructions for using the "--export" feature on the documents page (https://docs.openbb.co/terminal/guides/advanced/data) to help new users. (I am a new contributor so sorry in advance for any mistake in this process).

Description

  • Adding basic instructions for using --export feature
  • N/A
  • N/A
  • To provide instructions to help new users
  • N/A

How has this been tested?

N/A, just adding some content

  • 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.
  • Make sure affected commands still run in terminal
  • Ensure the SDK still works
  • Check any related reports

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.

@slateem
adding basic instructions for the export feature
fc71839 
As my first contribution I would like to propose adding some additional basic instructions for using the --export feature on this documents page
@reviewpad reviewpad bot added the feat XS Extra small feature label Nov 30, 2022
@deeleeramone
Copy link
Contributor

@slateem, great idea! I hope you don't mind, I made some changes; feel free to adapt to make it your own!

@deeleeramone deeleeramone added docs Code documentation guides Guides and online documentation labels Nov 30, 2022
JerBouma
JerBouma suggested changes Dec 1, 2022
View reviewed changes
Copy link
Contributor

@JerBouma JerBouma left a comment

Choose a reason for hiding this comment

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

Minor detail, other than that looks good.

website/content/terminal/guides/advanced/data.md Outdated
@@ -24,7 +24,7 @@ This folder contains all things user-created. For example:

The location of this folder can be set by the user from the `/settings` menu. There should be no need to update paths in this menu unless the folders have been moved manually.

<img width="1117" alt="The settings menu" src="https://user-images.githubusercontent.com/85772166/195736718-a1b821da-5977-437a-bd18-b44add2a29a2.png"></img>
[The Settings Menu](https://user-images.githubusercontent.com/85772166/195736718-a1b821da-5977-437a-bd18-b44add2a29a2.png "The Settings Menu")
Copy link
Contributor

Choose a reason for hiding this comment

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

Please make this an image, it is now a link. It should contain a ! in front.

@piiq
Copy link
Contributor

piiq commented Dec 1, 2022

new contributors are ❤️ @slateem

@slateem
Copy link
Contributor Author

slateem commented Dec 2, 2022

So here is what happened. In commit id bf74ff3 I forgot to save my changes before pushing the file, and so it only pushed the .vs/slnx.sqlite file (I guess vscode added that when I cloned).

Then in 31f95f5, I pushed the correct (I think) requested changes.

So now im not sure what to do about bf74ff3. Sorry guys...I'm still learning git.

@piiq
Copy link
Contributor

piiq commented Dec 2, 2022

@slateem Delete the .vs/... file locally and commit the deletion. After that the diff of the PR should not include this binary

@slateem slateem requested a review from JerBouma December 4, 2022 15:12
@jmaslek jmaslek merged commit 34b5d5a into OpenBB-finance:main Dec 6, 2022
@slateem
Copy link
Contributor Author

slateem commented Dec 6, 2022

Thanks for the help all! Love what you guys are doing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@piiq piiq piiq approved these changes

@JerBouma JerBouma Awaiting requested review from JerBouma

Assignees
No one assigned
Labels
docs Code documentation feat XS Extra small feature guides Guides and online documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@slateem @deeleeramone @piiq @JerBouma @jmaslek