Hi, Guilers,
I seem to have almost convinced at least one another person that
the docstring of sorted? predicate is at least misleading:
guile> (sorted? '(0 0) <)
#t
guile> (help sorted?)
`sorted?' is a primitive procedure in the (guile) module.
-- Scheme Procedure: sorted? items less
Return `#t' iff ITEMS is a list or a vector such that for all 1 <=
i <= m, the predicate LESS returns true when applied to all
elements i - 1 and i
My suggestion for the docstring is below (feel free to improve my broken
english).
Alexei
diff --git a/libguile/sort.c b/libguile/sort.c
index ecadd82..b71d101 100644
--- a/libguile/sort.c
+++ b/libguile/sort.c
@@ -101,9 +101,10 @@ SCM_DEFINE (scm_restricted_vector_sort_x,
"restricted-vector-sort!", 4, 0, 0,
* (not (less? (list-ref list i) (list-ref list (- i 1)))). */
SCM_DEFINE (scm_sorted_p, "sorted?", 2, 0, 0,
(SCM items, SCM less),
- "Return @code{#t} iff @var{items} is a list or a vector such that\n"
- "for all 1 <= i <= m, the predicate @var{less} returns true when\n"
- "applied to all elements i - 1 and i")
+ "Return @code{#t} iff @var{items} is a list or a vector such\n"
+ "that for all 1 <= i <= m, the predicate @var{less} returns\n"
+ "@code{#f} when comparing element i to the preceeding element\n"
+ "i - 1.")
#define FUNC_NAME s_scm_sorted_p
{
long len, j; /* list/vector length, temp j */
