Function: python-eldoc-function

python-eldoc-function is a byte-compiled function defined in python.el.gz.

Signature

(python-eldoc-function &rest IGNORED)

Documentation

eldoc-documentation-function for Python.

For this to work as best as possible you should call python-shell-send-buffer from time to time so context in inferior Python process is updated properly.

If python-eldoc-function-timeout seconds elapse before this function returns then if python-eldoc-function-timeout-permanent is non-nil python-eldoc-get-doc will be set to nil and eldoc will no longer return the documentation at the point automatically.

Set python-eldoc-get-doc to t to reenable eldoc documentation fetching.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/python.el.gz
(defun python-eldoc-function (&rest _ignored)
  "`eldoc-documentation-function' for Python.
For this to work as best as possible you should call
`python-shell-send-buffer' from time to time so context in
inferior Python process is updated properly.

If `python-eldoc-function-timeout' seconds elapse before this
function returns then if
`python-eldoc-function-timeout-permanent' is non-nil
`python-eldoc-get-doc' will be set to nil and eldoc will no
longer return the documentation at the point automatically.

Set `python-eldoc-get-doc' to t to reenable eldoc documentation
fetching."
  (when python-eldoc-get-doc
    (with-timeout (python-eldoc-function-timeout
                   (if python-eldoc-function-timeout-permanent
                       (progn
                         (message "ElDoc echo-area display muted in this buffer, see `python-eldoc-function'")
                         (setq python-eldoc-get-doc nil))
                     (message "`python-eldoc-function' timed out, see `python-eldoc-function-timeout'")))
      (python-eldoc--get-doc-at-point))))