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

Update instructions on asking for help #163

Merged
merged 1 commit into from
Jul 22, 2024
Merged

Update instructions on asking for help #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/help.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ Provide Adequate Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Nothing makes it easier to help you than information. The more information
you provide, the easier it'll be to help you. If you are asking for advice on
how to do something, share whatever code you've written or research you've
performed. If you're asking for help about an error, make sure you provide **at
least** the following information:
you provide, the easier it'll be to help you. At the very least, you should
provide the code you're using. If you're shy about your code, write a small test
script to demonstrate the issue. Also, make sure you `wrap your code in backticks
to make it easier to read <https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline#h_01GY0DAKGXDEHE263BCAYEGFJA>`__.

In addition to your code, it would really help if you shared:

1. Your OS (Windows? Mac OS? Linux?) and execution environment (VSCode? A raw
terminal? A docker container in the cloud?)
terminal? A notebook? A docker container in the cloud?)
2. Your ``schwab-py`` version. You can see this by
executing``print(schwab.__version__)`` in a python shell. Make sure you're
using the most recent version *before* asking for help. You can ensure this
using ``pip install --upgrade schwab-py``.
executing``print(schwab.__version__)`` in a python shell. Make sure you're
using the most recent version *before* asking for help. You can ensure this
using ``pip install --upgrade schwab-py`
3. The full stack trace and error message. Descriptions of errors will be met
with requests to provide more information.
4. Code that reproduces the error. If you're shy about your code, write a small
script that reproduces the error when run.
with requests to provide more information.

Optionally, you may want to share diagnostic logs generated by ``schwab-py``.
Not only does this provide even more information to the community, reading
Expand Down
Loading