Doc string for `sort'

Doc string for `sort'

[Kim F. Storm]

The doc string for `sort' has the following requirement:

Returns the sorted list.  LIST is modified by side effects.
PREDICATE is called with two elements of LIST, and should return t
if the first element is "less" than the second.  */)

The lisp ref, says the same thing:

     The argument PREDICATE must be a function that accepts two
     arguments.  It is called with two elements of LIST.  To get an
     increasing order sort, the PREDICATE should return `t' if the
     first element is "less than" the second, or `nil' if not.


Looking at the code, PREDICATE just need to return non-nil;
so is there a reason why the doc string says the return 
value should be `t' rather than any non-`nil' value?

-- 
Kim F. Storm <storm@cua.dk> http://www.cua.dk

Re: Doc string for `sort'

[Richard Stallman]

    Looking at the code, PREDICATE just need to return non-nil;
    so is there a reason why the doc string says the return 
    value should be `t' rather than any non-`nil' value?

No reason--you could fix the docs if you want.