Submit a Report¶

If you lot can't fix your event with any of the troubleshooting steps, then y'all'll desire to submit it to our issue tracker and so our team can take a look at information technology for yous. You'll need a Github account to do this, and then brand sure you take 1 before you brainstorm (a good idea anyhow).

Github page on Spyder's issue tracker

Of import

Earlier you submit an issue, make certain you've searched a clarification of the problem and a relevant portion of the error traceback, on both Google and Spyder's consequence tracker to make sure it hasn't been submitted before. If that's the instance, your issue volition be airtight every bit a duplicate.

Ways to submit an issue¶

At that place are several ways to submit an issue, either from Spyder or GitHub straight. In society of preference and difficulty:

  1. If Spyder presents an error dialog you can submit an event directly from information technology. Yous will accept to fill out a title for your outcome, specify the steps that pb to this trouble and click submit to Github. This volition prefill an error report with your surroundings details, key versions and dependencies and automatically insert the fault/traceback for y'all.

    Github page on Spyder's issue tracker

  2. If Spyder opens and your issue does non involve an mistake dialog, the best way to do so is to only select Study issue from the Help menu, which manually brings up the result written report form and fills in the central information about your Spyder installation. Describe the issue you're experiencing (including whatever error/traceback information) along with a descriptive title, and click Submit to Github.

    Github page on Spyder's issue tracker

  3. If Spyder won't launch, you tin can submit a written report manually at our issues page on Github. Unlike the above, you'll need to manually provide the versions of everything (Spyder, Python, Bone, Qt/PyQt, Anaconda, and Spyder's dependencies) every bit listed in the error report template; run across below for more on that.

    Github page on Spyder's issue template

In one case you submit your study, our squad volition attempt to become dorsum to you as before long equally possible, often within 24 hours or less, to effort to help you fix it.

What to include in your report¶

Please include every bit much every bit possible of the following in your report to maximize your chances of getting relevant help and our ability to diagnose, reproduce and solve your issue.

The key items, in order of priority:

  • The full, complete error message or traceback re-create/pasted or automatically entered exactly equally displayed by Spyder:

    • Auto-generated reports directly from the error dialog should include this automatically, simply double check to make certain.

    • You lot can copy and paste this from the the Prove Details section of the error dialog.

    • If not nowadays, or a dialog is non displayed, you can too detect information technology printed to Spyder's Internal Console, located under the View menu at .

    • If you prefer, or if Spyder won't beginning, you can start Spyder from your command line (or Anaconda prompt on windows) with spyder and copy the output printed there.

    Note

    If you are reporting a specific behavior rather than an mistake, or the bulletin does not fully explicate what occurs, please describe in detail what actually happened, and what you expected Spyder to practise.

  • A detailed, step past step description of exactly what you did leading up to the fault occurring, complete with sample code that triggers information technology, if applicative.

  • Information about Spyder and its surroundings as listed in the fault report template, which you can find nether About Spyder in the Help menu; along with its primal dependencies, shown in the dialog under (there's a button to copy-paste them).

    Spyder showing Spyder's info and dependencies

    If Spyder won't launch, paste the output of conda list from your control line (or Anaconda prompt on Windows) in the Dependencies section of the issue template.

    Command line showing output of conda list

  • How you installed Spyder and whatever other relevant packages, e.g. Anaconda, MacPorts or pip and whether Spyder has worked earlier since you installed it.

  • What else you've tried to set it, e.g. from this guide or elsewhere on the web, and if yous've tried to reproduce it in standalone QtConsole, IPython, and/or the plain Python interpreter.

  • Whether the problem occurred consistently before in similar situations or if this is the get-go time yous've observed it.

  • Annihilation else special or unusual about your system, environment, packages, or specific usage that might have anything to practise with the trouble

Tip

If including block(s) of code in your study, be sure to precede and follow it with a line of three backticks ``` to become a lawmaking block like this:

Otherwise, your code will likely incorporate random formatting or missing indentation, making it difficult to examine and run information technology to reproduce and gear up your issue.