GNU logs - #22665, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#22665: 24.5; PROPOSAL: add full docs for symbol at point for Python mode along with existing one-line.
Resent-From: Oleksandr Gavenko <gavenkoa@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sun, 14 Feb 2016 18:04:02 +0000
Resent-Message-ID: <handler.22665.B.14554729848813 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 22665 <at> debbugs.gnu.org
From: Oleksandr Gavenko <gavenkoa@HIDDEN>
Date: Sun, 14 Feb 2016 20:02:44 +0200
Message-ID: <871t8fp3uj.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

`python-eldoc-setup-code' from lisp/progmodes/python.el have:

        else:
            doc =3D doc.splitlines()[0]

This line from changes:

  commit 15cc40b8199735e600ddf718b936917ff4d79db0
  Author: Fabi=C3=A1n Ezequiel Gallina <fgallina@cuca>
  Date:   2012-05-17 00:03:18 -0300

    Fixed eldoc behavior.
=20=20=20=20
          * python-eldoc-setup-code: The code to get help now uses the
            inspect element. When an object doesn't have documentation and
            if it is callable it returns the signature for it. Also when
            an object does contain documentation it only returns the first
            line.

***Also when an object does contain documentation it only returns the first
   line.***

Current code uses `message' to display docs. Previous uses
`with-output-to-temp-buffer'.

In some situation I want to see full docs.

I don't use Python regularly and professionally so one line explanation is =
not
helpful at all.

Please add alternative function to display full doc in separate buffer (if
text is longer then one line??).

It can be done on same key binding but require command prefix.

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

I made dirty hack to my .emacs based on latest sources, but I like to use
official solution (the difference is that I strip ".splitlines()[0]"):

(defvar my/python-eldoc-setup-code
  "def __PYDOC_get_full_help(obj):
    try:
        import inspect
        try:
            str_type =3D basestring
        except NameError:
            str_type =3D str
        if isinstance(obj, str_type):
            obj =3D eval(obj, globals())
        doc =3D inspect.getdoc(obj)
        if not doc and callable(obj):
            target =3D None
            if inspect.isclass(obj) and hasattr(obj, '__init__'):
                target =3D obj.__init__
                objtype =3D 'class'
            else:
                target =3D obj
                objtype =3D 'def'
            if target:
                args =3D inspect.formatargspec(
                    *inspect.getargspec(target)
                )
                name =3D obj.__name__
                doc =3D '{objtype} {name}{args}'.format(
                    objtype=3Dobjtype, name=3Dname, args=3Dargs
                )
    except:
        doc =3D ''
    return doc"
  "Python code to setup documentation retrieval.")

(defvar my/python-eldoc-string-code "__PYDOC_get_full_help('''%s''')"
  "Python code used to get a string with the documentation of an object.")

;; For built-in python.el
(with-eval-after-load 'python
  (add-to-list 'python-shell-setup-codes 'my/python-eldoc-setup-code) ; Use=
d inside (python-shell-send-setup-code)
  (defun my/python-eldoc-at-point (&optional symbol)
    (interactive
     (let ((symbol (python-info-current-symbol t))
           (enable-recursive-minibuffers t))
       (list (read-string (if symbol
                              (format "Describe symbol (default %s): " symb=
ol)
                            "Describe symbol: ")
                          nil nil symbol))))
    (let ( (python-eldoc-string-code my/python-eldoc-string-code)
           (python-eldoc-setup-code my/python-eldoc-setup-code) )
      (switch-to-buffer (get-buffer-create "*Python-doc*"))
      (read-only-mode -1)
      (buffer-disable-undo)
      (erase-buffer)
      (insert (python-eldoc--get-doc-at-point symbol))
      (goto-char (point-min))
      (when (re-search-forward "^u?'" (line-end-position) t)
        (replace-match ""))
      (while (re-search-forward "\\\\n" nil t)
        (replace-match "\n"))
      (goto-char (point-max))
      (when (eq ?' (char-before))
        (delete-char -1))
      (read-only-mode 1)
      (goto-char (point-min))))
  (define-key python-mode-map "\C-c\C-d" 'my/python-eldoc-at-point))

--=20
http://defun.work/

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Oleksandr Gavenko <gavenkoa@HIDDEN>
Subject: bug#22665: Acknowledgement (24.5; PROPOSAL: add full docs for
 symbol at point for Python mode along with existing one-line.)
Message-ID: <handler.22665.B.14554729848813.ack <at> debbugs.gnu.org>
References: <871t8fp3uj.fsf@HIDDEN>
X-Gnu-PR-Message: ack 22665
X-Gnu-PR-Package: emacs
Reply-To: 22665 <at> debbugs.gnu.org
Date: Sun, 14 Feb 2016 18:04:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 22665 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
22665: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D22665
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Last modified: Mon, 25 Nov 2019 12:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.