Add documentation.
This commit is contained in:
parent
614adf31cb
commit
6ec5d76aeb
|
@ -35,19 +35,61 @@
|
|||
<ul>
|
||||
<li><code>mkstr</code>: concatenates its symbols and returns the printable representation
|
||||
of the result</li>
|
||||
<li><code>symb</code>: passes its arguments to <code>mkstr</code>
|
||||
to produce a printable representation, and returns the symbol built
|
||||
from this result; if the symbol does not exist, it will be
|
||||
created.</li>
|
||||
<li><code>group</code>: takes a list as input and produces a
|
||||
list of sublists of length n.</li>
|
||||
<li><code>flatten</code>: Returns a list of all atoms present in
|
||||
the provided list.</li>
|
||||
<li><code>compose</code>: allows a number of functions with the same arity
|
||||
to be composed together in a chain.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Let Over Lambda</h3>
|
||||
|
||||
<ul>
|
||||
<li><code>defmacro!</code>: provides automatic gensyms and
|
||||
once-only evaluation. Arguments that begin with g! will be
|
||||
automatically <code>gensym</code>'d, and arguments that begin with
|
||||
o! will only be evaluated once. Inside the body, the o! arguments
|
||||
should be called as their equivalent g! argument: o!x should be
|
||||
called in the body as g!x.
|
||||
</ul>
|
||||
|
||||
<h3>hash-table functions</h3>
|
||||
<ul>
|
||||
<li><code>sethash</code>: convenience function for setting a value
|
||||
in a hash table.</li>
|
||||
<li><code>hashkeys</code>: returns a list of all the keys in a hash
|
||||
table.</li>
|
||||
<li><code>hash-table-to-alist</code>: converts the hash table to an
|
||||
alist of <code>(key . value)</code> pairs.</li>
|
||||
<li><code>alist-to-hash-table</code>: converts an alist to a hash
|
||||
table.</li>
|
||||
<li><code>enable-hash-table-reader</code>: Enables the reader
|
||||
macro <code>#{}#</code> for hash tables. The resulting hash-table
|
||||
will use #'equal for equality. For example,
|
||||
|
||||
<pre>
|
||||
#{:a :b :c :d}#
|
||||
</pre>
|
||||
|
||||
will create a hash-table with the keys <code>:a</code>
|
||||
and <code>:c</code>. <code>:a</code> stores the value <code>:b</code>,
|
||||
and <code>:c</code> stores the value <code>:d</code>.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Quicklisp installation</h3>
|
||||
|
||||
<p>Clone into your Quicklisp project's <code>local-projects/</code>
|
||||
subdirectory, and call <code>(ql:quickload :kutils)</code>.</p>
|
||||
|
||||
<h3>CVS</h3>
|
||||
<h3>Git</h3>
|
||||
|
||||
<p>You can <a
|
||||
href="http://common-lisp.net/cgi-bin/viewcvs.cgi/?cvsroot=sample">
|
||||
browse our CVS repository</a> or download the current development tree via
|
||||
anonymous cvs, as described <a href="/faq.shtml">here</a></p>
|
||||
<p>You can <a href="https://github.com/kisom/kutils">browse the
|
||||
Github repository</a>.</p>
|
||||
|
||||
<div class="footer">
|
||||
<a href="mailto:kyle (at) metacircular (dot) net">K. Isom</a>, 2015-04-06.
|
||||
|
|
Loading…
Reference in New Issue