[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
docstrings of noreturn and 1value
From: |
Luc Teirlinck |
Subject: |
docstrings of noreturn and 1value |
Date: |
Wed, 28 Dec 2005 17:04:04 -0600 (CST) |
The docstrings of `noreturn 'and `1value' violate several docstring
conventions, for instance the convention that the first line should be
a complete sentence (or two short complete sentences).
The patch below not only makes these docstrings follow the conventions
better, but I also believe that the alternative docstrings are shorter
and clearer. I can install if desired.
===File ~/subr-diff=========================================
*** subr.el 28 Dec 2005 10:28:10 -0600 1.491
--- subr.el 28 Dec 2005 16:57:32 -0600
***************
*** 42,58 ****
(defalias 'not 'null)
(defmacro noreturn (form)
! "Evaluates FORM, with the expectation that the evaluation will signal an
error
! instead of returning to its caller. If FORM does return, an error is
! signaled."
`(prog1 ,form
(error "Form marked with `noreturn' did return")))
(defmacro 1value (form)
! "Evaluates FORM, with the expectation that the same value will be returned
! from all evaluations of FORM. This is the global do-nothing
! version of `1value'. There is also `testcover-1value' that
! complains if FORM ever does return differing values."
form)
(defmacro lambda (&rest cdr)
--- 42,56 ----
(defalias 'not 'null)
(defmacro noreturn (form)
! "Evaluate FORM, expecting it not to return.
! If FORM does return, signal an error."
`(prog1 ,form
(error "Form marked with `noreturn' did return")))
(defmacro 1value (form)
! "Evaluate FORM, expecting a constant return value.
! This is the global do-nothing version. There is also `testcover-1value'
! that complains if FORM ever does return differing values."
form)
(defmacro lambda (&rest cdr)
============================================================
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- docstrings of noreturn and 1value,
Luc Teirlinck <=