[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Paragraph styles in doc strings

From: Andreas Schwab
Subject: Re: Paragraph styles in doc strings
Date: Mon, 09 May 2016 17:22:46 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux)

Lars Ingebrigtsen <address@hidden> writes:

> There seems to be three popular paragraph styles in Emacs doc strings.
> Indentation:
> -----
> (directory-files DIRECTORY &optional FULL MATCH NOSORT)
> Return a list of names of files in DIRECTORY.
> There are three optional arguments:
> If FULL is non-nil, return absolute file names.  Otherwise return names
>  that are relative to the specified directory.
> If MATCH is non-nil, mention only file names that match the regexp MATCH.
> If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
>  Otherwise, the list returned is sorted with ‘string-lessp’.
>  NOSORT is useful if you plan to sort the result yourself.
> -----

This isn't a paragraph style, but a list style, only without bullet
points or numbering.  In a typeset document there wouldn't be extra
space between the items.


Andreas Schwab, SUSE Labs, address@hidden
GPG Key fingerprint = 0196 BAD8 1CE9 1970 F4BE  1748 E4D4 88E3 0EEA B9D7
"And now for something completely different."

reply via email to

[Prev in Thread] Current Thread [Next in Thread]