mirror of
https://github.com/vale981/emacs-ipython-notebook
synced 2025-03-06 17:41:40 -05:00
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# Guidelines for submitting bug reports
|
|
|
|
Please use `M-x ein:dev-bug-report-template` to write a bug report. It pops up
|
|
a buffer containing system information and instructions for submitting a bug
|
|
report.
|
|
|
|
|
|
## Avoiding Common Emacs Traps
|
|
|
|
### Is it just Emacs?
|
|
|
|
Did you try the same thing in a normal IPython notebook, i.e. from the browser
|
|
interface?
|
|
|
|
### Your Emacs configuration
|
|
|
|
There is always the possibility of an unintended interaction with another
|
|
package, so to elimate this possibility the best way is to start EIN in a clean
|
|
Emacs (i.e., without your configuration).
|
|
|
|
You can use zeroein.el to start EIN in a clean Emacs. See the Quick try section
|
|
in the manual: http://millejoh.github.com/emacs-ipython-notebook/#quick-try
|
|
|
|
|
|
### Badly compiled file
|
|
|
|
Remove all `*.elc` files from EIN source directory and its dependencies. Then
|
|
restart Emacs and try to reproduce the problem.
|
|
|
|
You will have problem with compiled files if they are older than the
|
|
source files and/or the files are compiled with different Emacs
|
|
versions.
|
|
|
|
|
|
### Make sure that the right library is loaded.
|
|
|
|
Sometimes you accidentally load libraries from unexpected location,
|
|
if you installed it in different places in the past or another
|
|
Emacs lisp libraries you are using bundles the old version of the
|
|
libraries.
|
|
|
|
To make sure that all EIN dependencies are loaded from the intended
|
|
place, use `M-x locate-library`. Also, `M-x ein:dev-bug-report-template`
|
|
does it for you for all EIN dependencies.
|
|
|
|
|
|
## Log and backtrace
|
|
|
|
Please consider putting log and backtrace in your bug report.
|
|
Follow the instruction in the manual:
|
|
http://tkf.github.com/emacs-ipython-notebook/#reporting-issue
|