unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Miha Rihtarsic <miha@kamnitnik.top>
Cc: Lars Ingebrigtsen <larsi@gnus.org>, emacs-devel@gnu.org
Subject: Re: master 5a8a5e3d: Input fontification for M-x shell
Date: Fri, 09 Sep 2022 22:23:18 +0300	[thread overview]
Message-ID: <83mtb8bbdl.fsf@gnu.org> (raw)

> +(defcustom shell-indirect-setup-hook nil
> +  "Hook run after setting up an indirect shell fontification buffer."

Thank you for working on these features.  I have a general comment
about this and other of your changes that were installed recently:

It is not useful to have customizable user options whose doc string
doesn't explain their purpose.  It makes discovery and use of such
options much harder.  Imagine a user who upgrades to Emacs 29 and runs
"M-x customize-changed" to learn about new options in the new version:
what will such user understand by reading the doc string of this
option?  There's no explanation what are indirect shell fontification
buffers, nor how and for what purpose they are used.  Without that, it
is impossible to understand when and how this hook could be useful.

Could you please augment the doc string with the above in mind?

The same goes for several other hooks in your changes installed today.



             reply	other threads:[~2022-09-09 19:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-09 19:23 Eli Zaretskii [this message]
2022-09-10 15:53 ` master 5a8a5e3d: Input fontification for M-x shell miha
2022-09-10 15:46   ` Eli Zaretskii
2022-09-11 11:06     ` miha
2022-09-11 10:59       ` Lars Ingebrigtsen

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=83mtb8bbdl.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=larsi@gnus.org \
    --cc=miha@kamnitnik.top \
    /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).