Document new variable ein:completion-backend.

Also fix some typos and update documentation for related functions.
This commit is contained in:
John Miller 2017-07-14 21:10:19 -05:00
parent b855d0bfd4
commit cda6143270
4 changed files with 13 additions and 9 deletions

View file

@ -6,4 +6,8 @@ v0.13.0
* Added commands ``ein:jupyter-server-start``, ``ein:jupyter-server-stop``, and
``ein:jupyter-server-login-and-open``.
* New interface for configuring code completion. See the new customizable
variable `ein:completion-backend`.
* Because of this `ein:use-auto-complete` is now deprecated, but EIN will still
try to do the right thing if it sees this variable is still defined.

View file

@ -436,7 +436,7 @@ configurable variables are listed below.
Subpackages
^^^^^^^^^^^
.. el:variable:: ein:use-auto-complete
.. el:variable:: ein:completion-backend
.. el:variable:: ein:use-auto-complete-superpack
.. el:variable:: ein:ac-max-cache
.. el:variable:: ein:use-smartrep

View file

@ -86,9 +86,9 @@
"Setup auto-completion using EIN and Jedi.el_ together.
Jedi.el_ is a Python auto-completion library for Emacs.
To use EIN and Jedi together, add the following in your Emacs setup.::
To use EIN and Jedi together, add the following in your Emacs setup before loading EIN.::
(add-hook 'ein:connect-mode-hook 'ein:jedi-setup)
(setq ein:completion-backend 'ein:use-ac-jedi-backend)
.. _Jedi.el: https://github.com/tkf/emacs-jedi"
(let ((map ein:connect-mode-map))

View file

@ -32,15 +32,15 @@
(declare-function ein:smartrep-config-once "ein-smartrep")
(defcustom ein:completion-backend 'ein:use-ac-backend
"Determines which completion backend to used in opened EIN notebooks.
"Determines which completion backend to use in opened EIN notebooks.
After changing the value of this variable it is recommended that
you restart Emacs. The available completion backends are:
you restart Emacs. The available completion backends are::
* ein:use-ac-backend : Use auto-complete with IPython's builtin completion engine.
* ein:use-ac-jedi-backend : Use auto-complete with the Jedi backend.
* ein:use-company-backend : Use company-mode with IPython's builtin completiong engine.
* ein:use-company-jedi-backends : Use company-mode with the Jedi backend (currently not implemented).
* ein:use-ac-backend : Use auto-complete with IPython's builtin completion engine.
* ein:use-ac-jedi-backend : Use auto-complete with the Jedi backend.
* ein:use-company-backend : Use company-mode with IPython's builtin completiong engine.
* ein:use-company-jedi-backends : Use company-mode with the Jedi backend (currently not implemented).
"
:type '(radio
(const :tag "Auto-Complete" 'ein:use-ac-backend)