Function: eshell-cmpl--custom-variable-docstring

eshell-cmpl--custom-variable-docstring is a byte-compiled function defined in em-cmpl.el.gz.

Signature

(eshell-cmpl--custom-variable-docstring PCOMPLETE-VAR)

Documentation

Generate the docstring of a variable derived from a pcomplete-* variable.

Source Code

;; Defined in /usr/src/emacs/lisp/eshell/em-cmpl.el.gz
(defun eshell-cmpl--custom-variable-docstring (pcomplete-var)
  "Generate the docstring of a variable derived from a pcomplete-* variable."
  (format "%s\n\nIts value is assigned to `%s' locally after eshell starts."
          (documentation-property pcomplete-var
                                  'variable-documentation t)
          (symbol-name pcomplete-var)))