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

Add traceback to info help #164

Merged
merged 6 commits into from Jan 3, 2019

Conversation

Projects
None yet
3 participants
@SebastiaanZ
Copy link
Member

SebastiaanZ commented Jan 2, 2019

Tracebacks are often a vital part of the help process on our server. Unfortunately, users often exclude vital parts of the traceback when formulating their questions and most beginners feel overwhelmed when confronted by tracebacks after running their code. This PR intents to help us in that process by adding information on how to read tracebacks to the help-page, telling the asker to inspect the traceback before asking a question, and telling them to include the full traceback in their question if their code raises an exception.

From top to bottom, these are the proposed changes to the page:

  • Adding traceback inspection to the Before you ask section:

Before you ask

  • Adding the traceback to things you need to have at hand in A good question:

A good question

  • A new section called "Examining Tracebacks":

Examining Tracebacks Part I

(Continued with small overlap:)

Examining Tracebacks Part II

(Continued with small overlap:)

Examining Tracebacks Part III

@jchristgit
Copy link
Member

jchristgit left a comment

Very useful. I like it.

@scragly

scragly approved these changes Jan 3, 2019

Copy link
Member

scragly left a comment

Looks like a good addition. Nice stuff.

@scragly scragly merged commit 1100675 into master Jan 3, 2019

@scragly scragly deleted the add-traceback-to-info-help branch Jan 3, 2019

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