unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
@ 2013-04-15 20:33 Drew Adams
  2019-08-15  5:21 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-04-15 20:33 UTC (permalink / raw)
  To: 14212

Subject line says it all.  The manual does not respect the style of
other Emacs doc, such as the Elisp manual.
 
In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600)
 of 2013-04-15 on ODIEONE
Bzr revision: 112292
agustin.martin@hispalinux.es-20130415100014-3vaie95fyec9wk37
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib'
 






^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
  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
  0 siblings, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2019-08-15  5:21 UTC (permalink / raw)
  To: Drew Adams; +Cc: 14212

"Drew Adams" <drew.adams@oracle.com> writes:

> 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?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
  2019-08-15  5:21 ` Lars Ingebrigtsen
@ 2019-08-15 13:06   ` Noam Postavsky
  2019-08-15 13:43     ` Drew Adams
  2019-08-15 23:48     ` Lars Ingebrigtsen
  0 siblings, 2 replies; 6+ messages in thread
From: Noam Postavsky @ 2019-08-15 13:06 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 14212

Lars Ingebrigtsen <larsi@gnus.org> writes:

> "Drew Adams" <drew.adams@oracle.com> writes:
>
>> 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





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
  2019-08-15 13:06   ` Noam Postavsky
@ 2019-08-15 13:43     ` Drew Adams
  2019-08-15 23:48     ` Lars Ingebrigtsen
  1 sibling, 0 replies; 6+ messages in thread
From: Drew Adams @ 2019-08-15 13:43 UTC (permalink / raw)
  To: Noam Postavsky, Lars Ingebrigtsen; +Cc: 14212

> >> 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'.





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
  2019-08-15 13:06   ` Noam Postavsky
  2019-08-15 13:43     ` Drew Adams
@ 2019-08-15 23:48     ` Lars Ingebrigtsen
  2019-08-16 13:47       ` Eli Zaretskii
  1 sibling, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2019-08-15 23:48 UTC (permalink / raw)
  To: Noam Postavsky; +Cc: 14212

Noam Postavsky <npostavs@gmail.com> writes:

> 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

Ah, I see.  Yes, that seems like something that should be fixed...  and
I'll leave it for somebody else.  :-)

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#14212: 24.3.50; Dired-X manual - variables have no `Variable' or `User Option' headings
  2019-08-15 23:48     ` Lars Ingebrigtsen
@ 2019-08-16 13:47       ` Eli Zaretskii
  0 siblings, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2019-08-16 13:47 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 14212-done, npostavs

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Thu, 15 Aug 2019 16:48:21 -0700
> Cc: 14212@debbugs.gnu.org
> 
> > 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
> 
> Ah, I see.  Yes, that seems like something that should be fixed...  and
> I'll leave it for somebody else.  :-)

Someone else here.

Fixed.





^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2019-08-16 13:47 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2019-08-15 23:48     ` Lars Ingebrigtsen
2019-08-16 13:47       ` Eli Zaretskii

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).