procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

python.el doc fixes

Browse source 
* lisp/progmodes/python.el (python-shell-accept-process-output):
(python-shell-comint-end-of-output-p):
(python-shell-first-prompt-hook):
(python-info-beginning-of-backslash): Doc fixes.
This commit is contained in:
Charles A. Roelli 2017-12-17 17:09:55 +01:00
parent c62ced5b4d
commit c51e797bba
1 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
lisp/progmodes/python.el
View file

@ -2451,7 +2451,7 @@ the `buffer-name'."
Optional argument TIMEOUT is the timeout argument to Optional argument TIMEOUT is the timeout argument to
`accept-process-output' calls. Optional argument REGEXP `accept-process-output' calls. Optional argument REGEXP
overrides the regexp to match the end of output, defaults to overrides the regexp to match the end of output, defaults to
`comint-prompt-regexp.'. Returns non-nil when output was `comint-prompt-regexp'. Returns non-nil when output was
properly captured. properly captured.
This utility is useful in situations where the output may be This utility is useful in situations where the output may be
@ -2469,7 +2469,7 @@ banner and the initial prompt are received separately."
(throw 'found t)))))) (throw 'found t))))))
(defun python-shell-comint-end-of-output-p (output) (defun python-shell-comint-end-of-output-p (output)
"Return non-nil if OUTPUT is ends with input prompt." "Return non-nil if OUTPUT ends with input prompt."
(string-match (string-match
;; XXX: It seems on macOS an extra carriage return is attached ;; XXX: It seems on macOS an extra carriage return is attached
;; at the end of output, this handles that too. ;; at the end of output, this handles that too.
@ -2674,10 +2674,9 @@ With argument MSG show activation/deactivation message."
"Hook run upon first (non-pdb) shell prompt detection. "Hook run upon first (non-pdb) shell prompt detection.
This is the place for shell setup functions that need to wait for This is the place for shell setup functions that need to wait for
output. Since the first prompt is ensured, this helps the output. Since the first prompt is ensured, this helps the
current process to not hang waiting for output by safeguarding current process to not hang while waiting. This is useful to
interactive actions can be performed. This is useful to safely safely attach setup code for long-running processes that
attach setup code for long-running processes that eventually eventually provide a shell."
provide a shell."
:version "25.1" :version "25.1"
:type 'hook :type 'hook
:group 'python) :group 'python)
@ -4826,7 +4825,7 @@ With optional argument LINE-NUMBER, check that line instead."
(point-marker))))) (point-marker)))))
(defun python-info-beginning-of-backslash (&optional line-number) (defun python-info-beginning-of-backslash (&optional line-number)
"Return the point where the backslashed line start. "Return the point where the backslashed line starts.
Optional argument LINE-NUMBER forces the line number to check against." Optional argument LINE-NUMBER forces the line number to check against."
(save-excursion (save-excursion
(save-restriction (save-restriction