comparison lispref/tips.texi @ 54124:17dfaa4af669

(Documentation Tips): Fix typo.
author Luc Teirlinck <teirllm@auburn.edu>
date Sun, 22 Feb 2004 16:20:09 +0000
parents ff694e194b01
children 4732f3096a88
comparison
equal deleted inserted replaced
54123:30685d763c2d 54124:17dfaa4af669
536 first line should mention the first few arguments, including the most 536 first line should mention the first few arguments, including the most
537 important arguments. 537 important arguments.
538 538
539 @item 539 @item
540 For consistency, phrase the verb in the first sentence of a function's 540 For consistency, phrase the verb in the first sentence of a function's
541 documentation string as an imperative--for instance, use ``Return the 541 documentation string as an imperative---for instance, use ``Return the
542 cons of A and B.'' in preference to ``Returns the cons of A and B@.'' 542 cons of A and B.'' in preference to ``Returns the cons of A and B@.''
543 Usually it looks good to do likewise for the rest of the first 543 Usually it looks good to do likewise for the rest of the first
544 paragraph. Subsequent paragraphs usually look better if each sentence 544 paragraph. Subsequent paragraphs usually look better if each sentence
545 is indicative and has a proper subject. 545 is indicative and has a proper subject.
546 546