unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Noam Postavsky <npostavs@gmail.com>, Lars Ingebrigtsen <larsi@gnus.org>
Cc: 14212@debbugs.gnu.org
Subject: bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
Date: Thu, 15 Aug 2019 06:43:26 -0700 (PDT)	[thread overview]
Message-ID: <6153155e-a064-4071-bec4-e4668a47daa3@default> (raw)
In-Reply-To: <87wofepogv.fsf@gmail.com>

> >> Subject line says it all.  The manual does not respect the style of
> >> other Emacs doc, such as the Elisp manual.
> >
> > I'm not quite sure what you mean here.  There's nodes like "Advanced
> > Cleaning Variables" -- what are you missing?
> 
> I think the problem is that doc/misc/dired-x.texi says stuff like
> 
>     @table @code
> 
>     @vindex dired-omit-mode
>     @item dired-omit-mode
>     [...]
> 
> Where it should say
> 
>     @defvar dired-omit-mode
>     [...]
>     @end defvar

I don't speak Texinfo, but yes, probably.

To repeat: "Subject line says it all."  Contrast the
Elisp manual, where variable descriptions are introduced
with `Variable' or `User Option', macros are introduced
with `Macro', and functions are introduced with `Command'
or `Function'.

See (elisp) `A Sample Variable Description'.





  reply	other threads:[~2019-08-15 13:43 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-15 20:33 bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings Drew Adams
2019-08-15  5:21 ` Lars Ingebrigtsen
2019-08-15 13:06   ` Noam Postavsky
2019-08-15 13:43     ` Drew Adams [this message]
2019-08-15 23:48     ` Lars Ingebrigtsen
2019-08-16 13:47       ` Eli Zaretskii

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=6153155e-a064-4071-bec4-e4668a47daa3@default \
    --to=drew.adams@oracle.com \
    --cc=14212@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    --cc=npostavs@gmail.com \
    /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).