Skip to content

133: added warning to README.org about possible conflicts with ob-ipython #135

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

Merged
merged 4 commits into from
Jul 24, 2019
Merged

133: added warning to README.org about possible conflicts with ob-ipython #135

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
867689b
133: added to README.org warn about possible conflicts with ob-ipython
cheremin Jun 22, 2019
43600c0
133: reformatted changes in README.org
cheremin Jun 24, 2019
9af089d
Merge branch 'master' of https://github.com/dzop/emacs-jupyter into 1…
cheremin Jul 21, 2019
1967c53
133: adjusted explanation to include new information
cheremin Jul 21, 2019
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
5 changes: 5 additions & 0 deletions README.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,11 @@ example you can put the following in your configuration:
(setq ob-async-no-async-languages-alist '("jupyter-python" "jupyter-julia"))
#+END_SRC

*** Issues with =ob-ipython=
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this.

Can you run M-x org-fill-paragraph (bound to M-q) on the two paragraphs so that they are formatted like the rest of the document.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, np, here is it

If you already have =ob-ipython= installed, you /may/ experience issues with it conflicting with =emacs-jupyter= (e.g. [[https://github.com/dzop/emacs-jupyter/issues/133#issuecomment-502444999][this issue]). This is still not clearly investigated, but worth to keep in mind.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are missing the ending bracket of the link.

Suggested change
If you already have =ob-ipython= installed, you /may/ experience issues with it conflicting with =emacs-jupyter= (e.g. [[https://github.com/dzop/emacs-jupyter/issues/133#issuecomment-502444999][this issue]). This is still not clearly investigated, but worth to keep in mind.
If you already have =ob-ipython= installed, you /may/ experience issues with it conflicting with =emacs-jupyter= (e.g. [[https://github.com/dzop/emacs-jupyter/issues/133#issuecomment-502444999][this issue]]). This is still not clearly investigated, but worth to keep in mind.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also can we remove the part This is still not clearly investigated, but worth to keep in mind. and just give a brief explanation of the linked issue.

I took a look at ob-ipython and it has to do with its Jupyter kernel support. Both emacs-jupyter and ob-ipython try to take ownership of jupyter-LANG source block names. So if both ob-ipython and emacs-jupyter are installed, ob-ipython will partially override what emacs-jupyter does to handle jupyter-LANG source blocks. The only way to suppress this is to remove the org-mode-hook function added by ob-ipython before an org-mode file is opened. Due to this, ob-ipython and emacs-jupyter are incompatible.

So you can actually replace this whole paragraph saying that ob-ipython must be uninstalled in order for emacs-jupyter to work properly since both packages define jupyter-LANG source blocks and, if you want, mention a little about why from the explanation above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I have rephrase this block according to your investigation.

BTW: Thank you for investigation -- as for me, it is much simpler to just know tools are inherently incompatible, then guess that else could be the cause of incompatibility


If you have issues with =ob-jupyter= source block result is not inserted, and =error in process sentinel: Search failed:...= message is displayed in minibuffer, then try disable =ob-ipython= and see, is it help. Usually, it is enough to remove =ipython= from =(org-babel-do-load-languages ...)= list, and restart your Emacs.

*** Overriding built-in src-block languages

You may find having to specify the names of Jupyter source blocks using
Expand Down