Skip to content

Commit

Permalink
Update instructions on asking for help (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexgolec authored Jul 22, 2024
1 parent 1c27f10 commit 234ea4d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/help.rst
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

0 comments on commit 234ea4d

Please sign in to comment.