[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#23609: 25.0.92; Python eldoc freeze
From: |
Jules Tamagnan |
Subject: |
bug#23609: 25.0.92; Python eldoc freeze |
Date: |
Tue, 31 May 2016 13:35:27 -0400 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.0.92 (gnu/linux) |
Eli Zaretskii <eliz@gnu.org> writes:
> Thanks. We should try making the message text shorter, so it fits on
> a single line.
>
>> We could also perhaps make it such that if the timeout variable were
>> negative then instead of permanently stopping eldoc it would only
>> return, like you had suggested. A boolean defcustom could also be
>> used for that if we want.
>
> I don't see any significant advantage either way.
>
>> Also 'python-eldoc--get-doc' could be renamed to not be private if we
>> expect somebody to want to change it
>
> Yes, that variable should not be private if users are expected to set
> it. Alternatively, we could add a simple command to set the variable
> non-nil, which might also help making the message text shorter.
I've improved the documentation, added the boolean to make the timeout
permanent and shortened the messages
index 5aeefe4..d555e21 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -4293,12 +4293,45 @@ python-eldoc--get-doc-at-point
(unless (zerop (length docstring))
docstring)))))
+(defvar-local python-eldoc-get-doc t
+ "Non-nil means eldoc should fetch the documentation
+ automatically. Set to nil by `python-eldoc-function' if
+ `python-eldoc-function-timeout-permanent' is non-nil and
+ `python-eldoc-function' times out.")
+
+(defcustom python-eldoc-function-timeout 1
+ "Timeout for `python-eldoc-function' in seconds."
+ :group 'python
+ :type 'integer)
+
+(defcustom python-eldoc-function-timeout-permanent t
+ "Non-nil means that when `python-eldoc-function' times out
+`python-eldoc-get-doc' will be set to nil"
+ :group 'python
+ :type 'boolean)
+
(defun python-eldoc-function ()
"`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."
- (python-eldoc--get-doc-at-point))
+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 current
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))))
(defun python-eldoc-at-point (symbol)
"Get help on SYMBOL using `help'.
- bug#23609: 25.0.92; Python eldoc freeze, (continued)
- bug#23609: 25.0.92; Python eldoc freeze, Eli Zaretskii, 2016/05/27
- bug#23609: 25.0.92; Python eldoc freeze, Jules Tamagnan, 2016/05/27
- bug#23609: 25.0.92; Python eldoc freeze, Eli Zaretskii, 2016/05/27
- bug#23609: 25.0.92; Python eldoc freeze, Jules Tamagnan, 2016/05/27
- bug#23609: 25.0.92; Python eldoc freeze, Eli Zaretskii, 2016/05/27
- bug#23609: 25.0.92; Python eldoc freeze, Jules Tamagnan, 2016/05/27
- bug#23609: 25.0.92; Python eldoc freeze, Eli Zaretskii, 2016/05/28
- bug#23609: 25.0.92; Python eldoc freeze,
Jules Tamagnan <=
- bug#23609: 25.0.92; Python eldoc freeze, Andreas Röhler, 2016/05/27