bug#42323: 26.3; Doc string of `seq-map'

[Stefan Kangas]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Drew Adams <drew.adams@oracle.com> writes:
>
>> Or IF understanding the implementation is really necessary, then the
>> fact that seq.el is implemented using cl constructs can't be elided.
>
> This is the current doc string:
>
> ---
> seq-map is a compiled Lisp function in ‘seq.el’.
>
> (seq-map FUNCTION SEQUENCE)
>
>   Other relevant functions are documented in the sequence group.
>
> Return the result of applying FUNCTION to each element of SEQUENCE.
>
> This is a generic function.
>
> Implementations:
>
> #'(sequence sequence) in ‘seq.el’.
>
> Undocumented
>
> #'sequence in ‘seq.el’.
>
> Undocumented
> ---
>
> It is, indeed, pretty obscure.  Like Drew, I wonder -- do we really have
> to put these implementation details in the doc string at all?  Opinions?

These details are now moved to the bottom of the help screen, below the
information that is immediately relevant.  Without a major re-design of
the help screen, I think that's as good as it gets for now:

    seq-map is a compiled Lisp function in ‘seq.el’.

    (seq-map FUNCTION SEQUENCE)

    Return the result of applying FUNCTION to each element of SEQUENCE.

      Other relevant functions are documented in the sequence group.



    This is a generic function.

    Implementations:

    #'(sequence sequence) in ‘seq.el’.

    Undocumented

    #'sequence in ‘seq.el’.

    Undocumented

I suggest closing this bug report as fixed in 28.1.