unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Arthur Miller <arthur.miller@live.com>
To: martin rudalics <rudalics@gmx.at>
Cc: emacs-devel@gnu.org
Subject: Re: Patch proposal: display symbol source code in help buffers
Date: Mon, 20 Sep 2021 20:13:41 +0200	[thread overview]
Message-ID: <AM9PR09MB49770A45C963E70C09D15CEE96A09@AM9PR09MB4977.eurprd09.prod.outlook.com> (raw)
In-Reply-To: <9ada9a31-4e44-7941-e9a2-ada86ba4e36e@gmx.at> (martin rudalics's message of "Mon, 20 Sep 2021 10:21:59 +0200")

martin rudalics <rudalics@gmx.at> writes:

>> Lastly hitting the `s' key opens another buffer in another
>> window (at least for me) and (also at least for me), at
>> surprising locations in my frame.  I have a UHD monitor and,
>> at least the way I configured it, emacs opens up to 4
>> windows, the help buffer and the source buffer not
>> necessarily adjunct.  All 4 windows can carry 92 lines, so
>> there is plenty of room below the text in the help buffer to
>> show more info.
>
> If you fit the window showing *Help* to its buffer, there is no room
> left.

It would be nice to make it fit to N lines in height, and C columns in width,
i.e. to make it fit to certain size.

>     .  Where to pop up the location of the source and how to get rid of
> it is a question we currently discuss in Bug#9054 and Bug#36767.

There are so many discussions here so I wasn't following those. I really don't
know what you have discussed there. I come to this from my own needs.

>                                                                   If and
> when we reach a consensus there, we can add an option to immediately
> display the source in the *Help* buffer or a window right below it (IIRC
> a C source wouldn't be always available though).

This shouldn't be by any mean in collision what you are saying here. What you
describe, as I understand it, is to display source on-demand, in help buffer,
which would be very nice too. What I have done is to display by global
switch. It would be still useful to have on-demand display when global switch is
off, and it would be trivial to re-build the patch to include that. I can
rebuild and send new one. I have found a bug and I need to rebuild-it anyway. I
can also refactor it and add an interactive function that can be boudn to a key
to display only sources in help buffer. And if global switch is on, and sources
are requested, it can function as a "narrow" button, i.e. fit only symbol source
to the help buffer. Would that be interesting?

Honestly, I dislike to display both help and entire source, because there is a
duplication of the doc string. I was always disturbed by this duplication in
helpful too. So I have experimented to display only the body of the function,
but I don't think that looked very nice either. There is a bug repport I did
about 'narrow-to-defun', and the help-mode.el I posted there, shows C sources
narrowed only to it's function body. 



  reply	other threads:[~2021-09-20 18:13 UTC|newest]

Thread overview: 58+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-19 19:50 Patch proposal: display symbol source code in help buffers Arthur Miller
2021-09-20  5:46 ` Lars Ingebrigtsen
2021-09-20  6:09   ` Stefan Kangas
2021-09-20  6:14     ` Lars Ingebrigtsen
2021-09-20  7:17       ` Ihor Radchenko
2021-09-20  7:43         ` Stefan Kangas
2021-09-20  8:29           ` martin rudalics
2021-09-20  9:04           ` Ihor Radchenko
2021-09-20 23:45             ` Arthur Miller
2021-09-21  4:16             ` Lars Ingebrigtsen
2021-09-21  6:59               ` Ihor Radchenko
2021-09-21  7:41                 ` Stefan Kangas
2021-09-21  8:38                   ` Eli Zaretskii
2021-09-21  9:17                     ` Ihor Radchenko
2021-09-21 16:49                       ` Lars Ingebrigtsen
2021-10-01  7:05                         ` Ihor Radchenko
2021-10-01  7:09                           ` Lars Ingebrigtsen
2021-10-01  7:21                             ` Ihor Radchenko
2021-10-01  7:21                               ` Lars Ingebrigtsen
2021-10-01  9:04                                 ` Ihor Radchenko
2021-10-01 12:20                                   ` Lars Ingebrigtsen
2021-10-01  7:24                           ` Eli Zaretskii
2021-10-01  9:08                             ` Ihor Radchenko
2021-10-01 10:24                               ` Eli Zaretskii
2021-10-01 14:14                                 ` Ihor Radchenko
2021-09-21  8:34               ` martin rudalics
2021-09-20 15:01           ` Arthur Miller
2021-09-21  7:41             ` Stefan Kangas
2021-09-20 15:27         ` Arthur Miller
2021-09-20  6:47     ` Eli Zaretskii
2021-09-20 15:27       ` Arthur Miller
2021-09-20 14:55     ` Arthur Miller
2021-09-21  4:18       ` Lars Ingebrigtsen
2021-09-21 10:26         ` Arthur Miller
2021-09-20 15:23   ` Arthur Miller
2021-09-20  5:59 ` Eli Zaretskii
2021-09-20  6:37   ` Gregor Zattler
2021-09-20  7:01     ` Eli Zaretskii
2021-09-20 15:21       ` Arthur Miller
2021-09-20  8:21     ` martin rudalics
2021-09-20 18:13       ` Arthur Miller [this message]
2021-09-21  8:34         ` martin rudalics
2021-09-21 10:24           ` Arthur Miller
2021-09-21 16:52             ` martin rudalics
2021-09-21 18:56               ` Arthur Miller
2021-09-21 17:30           ` Juri Linkov
2021-09-21 19:13             ` Arthur Miller
2021-09-22  7:49               ` martin rudalics
2021-09-22 16:04                 ` Juri Linkov
2021-09-22 17:52                   ` martin rudalics
2021-09-23  8:15                     ` martin rudalics
2021-09-23 15:52                       ` Juri Linkov
2021-09-26  9:10                         ` martin rudalics
2021-09-22 22:38                 ` Arthur Miller
2021-09-23  8:22                   ` martin rudalics
2021-09-20 12:19     ` Dmitry Gutov
2021-09-20 15:13       ` Arthur Miller
2021-09-20 15:11   ` Arthur Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=AM9PR09MB49770A45C963E70C09D15CEE96A09@AM9PR09MB4977.eurprd09.prod.outlook.com \
    --to=arthur.miller@live.com \
    --cc=emacs-devel@gnu.org \
    --cc=rudalics@gmx.at \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).