Skip to content

Commit

Permalink
Provide documentation for SUBSETP.
Browse files Browse the repository at this point in the history
  • Loading branch information
robert-strandh committed Aug 10, 2024
1 parent 92463c1 commit 59a34ea
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Code/TODO.text
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ cdmt set-difference
cdmt nset-difference
cdmt set-exclusive-or
cdmt nset-exclusive-or
c_mt subsetp
cdmt subsetp
cdmt union
cdmt nunion
15 changes: 15 additions & 0 deletions Code/subsetp.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,18 @@
key key-supplied-p
test test-supplied-p
test-not test-not-supplied-p))))

(setf (documentation 'subsetp 'function)
(format nil
"Syntax: subsetp list-1 list-2 &key key test test-not~@
~%~a~%~%~a~%~%~a~%~%~a~%~@
Either TEST or TEST-NOT is applied to the result of~@
applying KEY to an element of LIST-1 and and the result~@
of applying KEY to an element of LIST-2 in that order.~@
If for every element E1 of LIST-1, there is an element E2~@
of LIST-2 such that E1 and E2 satisfy the test, then this~@
function returns true. Otherwise, it returns false."
*list-1-and-list-2-must-be-proper*
*key*
*key-applied-to-elements-of-list-1-and-list-1*
*test-and-test-not*))

0 comments on commit 59a34ea

Please sign in to comment.