[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#59286: Documentation for seq-count
From: |
Heime |
Subject: |
bug#59286: Documentation for seq-count |
Date: |
Wed, 16 Nov 2022 18:50:41 +0000 |
------- Original Message -------
On Wednesday, November 16th, 2022 at 6:09 PM, Jim Porter
<jporterbugs@gmail.com> wrote:
> On 11/16/2022 9:59 AM, Heime via Bug reports for GNU Emacs, the Swiss
> army knife of text editors wrote:
>
> > Fine, but how do you use that? No information, no example. Seems to me that
> > authors of documentation willfully avoid showing examples or where to find
> > them.
>
>
> In a Help buffer, just below the docstring is this message:
>
> Other relevant functions are documented in the sequence group.
>
> Clicking on "sequence" takes you to shortdocs, which shows an example:
>
> (seq-count #'numberp '(1 b c 4))
> ⇒ 2
>
> Maybe the "Other relevant functions" wording could be improved so that
> it's clearer though. It doesn't really indicate that you'll find more
> details about 'seq-count' in particular, just "other relevant
> functions". Something like, "See the sequence group for more
> information on this and other relevant functions," maybe?
It also says "Undocumented" at the end. Documentation is not as
helpful as many people think they are.