GNU bug report logs - #68963
30.0.50; [PATCH] Split Eshell built-in command documentation into subsections

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jim Porter <jporterbugs <at> gmail.com>
Cc: stefankangas <at> gmail.com, 68963 <at> debbugs.gnu.org
Subject: bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections
Date: Fri, 09 Feb 2024 09:05:18 +0200

> Date: Thu, 8 Feb 2024 12:30:46 -0800
> Cc: stefankangas <at> gmail.com, 68963 <at> debbugs.gnu.org
> From: Jim Porter <jporterbugs <at> gmail.com>
> 
> > No objections here.  But once again: your points about being able to
> > find the commands by categories are well-taken, and adding indexing to
> > make that easier would also be a good change.
> 
> Attached are some initial improvements to the indexing (patch 0003 in 
> the series). It would probably be worth adding concept indices to 
> most/all of the built-in commands, but the few I added here are pretty 
> straightforward, and I can just poke at this a bit at a time for the 
> remainder. (Writing documentation isn't the most viscerally exciting 
> thing to do, so I prefer to spread the work out.)
> 
> I also added patch 0002, which moves the indexing above the "@item"s. 
> That way, when you navigate to the entry from the index, it shows the 
> header line listing the supported arguments when viewing the 
> documentation as HTML.

LGTM, thanks.  Yes, index entries should always be before the
corresponding @item's.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.