unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Christopher Dimech <dimech@gmx.com>
Cc: 65913@debbugs.gnu.org, uzibalqa@proton.me,
	heimeborgia@protonmail.com, stefankangas@gmail.com,
	drew.adams@oracle.com
Subject: bug#65913: with-help-window arranges for 'inhibit-read-only' to be set to 't'
Date: Thu, 14 Sep 2023 19:55:13 +0300	[thread overview]
Message-ID: <83fs3glmoe.fsf@gnu.org> (raw)
In-Reply-To: <trinity-4c102df7-bb2e-4608-a137-824073cc65ab-1694709615933@3c-app-mailcom-bs10> (message from Christopher Dimech on Thu, 14 Sep 2023 18:40:16 +0200)

> From: Christopher Dimech <dimech@gmx.com>
> Cc: Drew Adams <drew.adams@oracle.com>, uzibalqa@proton.me,
>  heimeborgia@protonmail.com, stefankangas@gmail.com, 65913@debbugs.gnu.org
> Date: Thu, 14 Sep 2023 18:40:16 +0200
> 
> > Yes -- when either the manuals have information that is generally
> > expected to be in the doc string, but we decided not to have it there
> > (e.g., because it's very voluminous), or when the place in the manual
> > where to look is not trivially clear from the doc string.
> 
> I think the whole point is that if the information is available somewhere,
> one should be able to access it (voluminous or not).

Emacs shines in this area by providing commands that allow such easy
access.  One just has to use them.

> > In most cases, the place where to look for the related information in
> > the manuals is quite easily found: just visit the manual and then type
> > "i SYMBOL RET", where SYMBOL is the name of the variable or the
> > function whose doc string you are reading.
> 
> There could be some information in the "Introduction to Programming in
> Emacs Lisp" that illustrates an actual serious problem and how to get
> to the information from within Emacs itself in an efficient way.

We already have this in the Emacs user manual, see the beginning of
the chapter "Help".  It lists the various methods of finding relevant
information in the available documentation.





  reply	other threads:[~2023-09-14 16:55 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-13 10:41 bug#65913: with-help-window arranges for 'inhibit-read-only' to be set to 't' Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-13 13:13 ` Eli Zaretskii
2023-09-13 13:26   ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-13 13:56     ` Eli Zaretskii
2023-09-13 14:26       ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-13 14:04   ` Stefan Kangas
2023-09-13 14:46     ` Eli Zaretskii
2023-09-13 14:54       ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-13 15:21         ` Stefan Kangas
2023-09-13 19:03         ` Eli Zaretskii
2023-09-13 19:16           ` uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-14  4:53             ` Eli Zaretskii
2023-09-14 10:41               ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-14 12:50                 ` Eli Zaretskii
2023-09-14 13:17                   ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-14 16:03               ` Drew Adams
2023-09-14 16:15                 ` Eli Zaretskii
2023-09-14 16:40                   ` Christopher Dimech
2023-09-14 16:55                     ` Eli Zaretskii [this message]
2023-09-14 19:04                       ` Christopher Dimech
2023-09-14 16:29                 ` Christopher Dimech
2023-09-13 14:51     ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-13 15:14       ` Stefan Kangas
2023-09-13 15:34         ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-13 15:51           ` Stefan Kangas
2023-09-13 16:24             ` Heime via Bug reports for GNU Emacs, the Swiss army knife of text editors

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=83fs3glmoe.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=65913@debbugs.gnu.org \
    --cc=dimech@gmx.com \
    --cc=drew.adams@oracle.com \
    --cc=heimeborgia@protonmail.com \
    --cc=stefankangas@gmail.com \
    --cc=uzibalqa@proton.me \
    /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).