From: Andreas Schwab <schwab@suse.de>
To: emacs-devel@gnu.org
Subject: Re: Paragraph styles in doc strings
Date: Mon, 09 May 2016 17:22:46 +0200 [thread overview]
Message-ID: <mvm37prdznd.fsf@hawking.suse.de> (raw)
In-Reply-To: <878tzjjn3w.fsf@gnus.org> (Lars Ingebrigtsen's message of "Mon, 09 May 2016 16:57:07 +0200")
Lars Ingebrigtsen <larsi@gnus.org> 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.
--
Andreas Schwab, SUSE Labs, schwab@suse.de
GPG Key fingerprint = 0196 BAD8 1CE9 1970 F4BE 1748 E4D4 88E3 0EEA B9D7
"And now for something completely different."
next prev parent reply other threads:[~2016-05-09 15:22 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-09 14:57 Paragraph styles in doc strings Lars Ingebrigtsen
2016-05-09 15:01 ` Dmitry Gutov
2016-05-09 15:07 ` Kaushal Modi
2016-05-11 1:52 ` John Wiegley
2016-05-12 20:37 ` Lars Ingebrigtsen
2016-05-16 20:53 ` Stefan Monnier
2016-06-01 23:01 ` Clément Pit--Claudel
2016-06-02 1:18 ` Stefan Monnier
2016-06-20 19:11 ` Clément Pit--Claudel
2016-06-21 1:18 ` Stefan Monnier
2016-06-21 3:24 ` Clément Pit--Claudel
2016-05-18 6:05 ` John Wiegley
2016-05-09 16:05 ` Drew Adams
2016-05-09 15:10 ` Paul Eggert
2016-05-09 15:48 ` Marcin Borkowski
2016-05-09 16:12 ` Paul Eggert
2016-05-09 15:22 ` Andreas Schwab [this message]
2016-05-09 15:42 ` Lars Ingebrigtsen
2016-05-09 15:45 ` Marcin Borkowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=mvm37prdznd.fsf@hawking.suse.de \
--to=schwab@suse.de \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.