unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: lists@traduction-libre.org, asjo@koldfront.dk, stefan@marxist.se,
	monnier@iro.umontreal.ca, emacs-devel@gnu.org
Subject: Re: Add hints to documentation of car and cdr for (e)lisp newcomers - take 2
Date: Thu, 15 Jul 2021 19:57:57 +0300	[thread overview]
Message-ID: <83o8b35xbe.fsf@gnu.org> (raw)
In-Reply-To: <871r7zilp0.fsf@gnus.org> (message from Lars Ingebrigtsen on Thu,  15 Jul 2021 18:30:35 +0200)

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Thu, 15 Jul 2021 18:30:35 +0200
> Cc: asjo@koldfront.dk, Eli Zaretskii <eliz@gnu.org>, stefan@marxist.se,
>  Stefan Monnier <monnier@iro.umontreal.ca>, emacs-devel@gnu.org
> 
> I've now tweaked how the links in *Help* work so that they take you to
> the proper place in the shortdoc buffer.

Thanks, but could we perhaps improve it?  The display looks something
like this now:

  split-string-shell-command is an autoloaded Lisp function in
  ‘shell.el’.

  (split-string-shell-command STRING)

    Other relevant functions are documented in the string group.
                                                   ------
    Probably introduced at or before Emacs version 28.1.
                                                   ----
  Split STRING (a shell command) into a list of strings.
  General shell syntax, like single and double quoting, as well as
  backslash quoting, is respected.

The new sentence interrupts the continuity, and now "Probably
introduced at ..." is missing the context and sounds like bad English.

I think it would be better to move the reference to other functions to
the end of the *Help* buffer text.  After all, it's a kind-of "See
also", which is normally found at the end.



  reply	other threads:[~2021-07-15 16:57 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-14 15:05 Add hints to documentation of car and cdr for (e)lisp newcomers - take 2 Adam Sjøgren
2021-07-14 15:36 ` Andreas Schwab
2021-07-14 15:48 ` tomas
2021-07-14 15:50 ` Eli Zaretskii
2021-07-14 16:03   ` Lars Ingebrigtsen
2021-07-14 16:13     ` Eli Zaretskii
2021-07-15  4:34       ` Lars Ingebrigtsen
2021-07-14 23:49     ` Stefan Kangas
2021-07-15  4:38       ` Lars Ingebrigtsen
2021-07-15 11:39         ` Stefan Kangas
2021-07-15 14:14           ` Eli Zaretskii
2021-07-15 15:02             ` Tim Cross
2021-07-15 15:41               ` Stefan Monnier
2021-07-15 15:21             ` Stefan Monnier
2021-07-15 15:26               ` Yuan Fu
2021-07-15 15:52                 ` Eduardo Ochs
2021-07-15 15:44               ` Lars Ingebrigtsen
2021-07-15 15:57                 ` Eli Zaretskii
2021-07-16  0:22                   ` Stefan Monnier
2021-07-16  2:08                     ` Jean-Christophe Helary
2021-07-16 13:22                       ` Stefan Monnier
2021-07-16 14:38                         ` Basil L. Contovounesios
2021-07-16  7:00                     ` Eli Zaretskii
2021-07-15 15:53               ` Eli Zaretskii
2021-07-15 16:17                 ` Jean-Christophe Helary
2021-07-15 16:30                   ` Lars Ingebrigtsen
2021-07-15 16:57                     ` Eli Zaretskii [this message]
2021-07-15 17:01                       ` Lars Ingebrigtsen
2021-07-15 17:07                         ` Eli Zaretskii
2021-07-15 20:54                         ` Stefan Kangas
2021-07-15 21:11                           ` Lars Ingebrigtsen
2021-07-14 16:37 ` [External] : " Drew Adams

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=83o8b35xbe.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=asjo@koldfront.dk \
    --cc=emacs-devel@gnu.org \
    --cc=larsi@gnus.org \
    --cc=lists@traduction-libre.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=stefan@marxist.se \
    /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).