conservatory
/
picrin
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

use list notation and italic

This commit is contained in:
Yuichi Nishiwaki 2014-06-15 02:51:06 +09:00
parent da2a71fe65
commit d5e1f3f8ef
1 changed files with 18 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/libs.rst
View File

@ -37,7 +37,7 @@ Utility functions and syntaces for macro definition.
- define-macro - define-macro
- gensym - gensym
- macroexpand - macroexpand expr
Old-fashioned macro. Old-fashioned macro.
@ -55,33 +55,30 @@ Explicit renaming macro family.
(picrin regexp) (picrin regexp)
--------------- ---------------
.. glossary:: - *(regexp ptrn [flags])*
(regexp ptrn [flags]) Compiles pattern string into a regexp object. A string flags may contain any of #\g, #\i, #\m.
Compiles pattern string into a regexp object. A string flags may contain any of #\g, #\i, #\m. - *(regexp? obj)*
(regexp? obj) Judges if obj is a regexp object or not.
Judges if obj is a regexp object or not. - *(regexp-match re input)*
(regexp-match re input) Returns two values: a list of match strings, and a list of match indeces.
Returns two values: a list of match strings, and a list of match indeces. - *(regexp-replace re input txt)*
- *(regexp-split re input)*
(regexp-replace re input txt)
(regexp-split re input)
(picrin control) (picrin control)
---------------- ----------------
Delimited control operators. Delimited control operators.
(reset h) - *(reset h)*
^^^^^^^^^ - *(shift k)*
(shift k)
^^^^^^^^^
(picrin dictionary) (picrin dictionary)
------------------- -------------------
@ -90,37 +87,31 @@ Symbol to Object table. Internally it is implemented on hash-table.
Note that dictionary is not a weak map; if you are going to make a highly memory-consuming program with dictionaries, you should know that dictionaries keep their bound objects and never let them free until you explicitly deletes bindings. Note that dictionary is not a weak map; if you are going to make a highly memory-consuming program with dictionaries, you should know that dictionaries keep their bound objects and never let them free until you explicitly deletes bindings.
(dictionary) - *(dictionary)*
^^^^^^^^^^^^
Returns a newly allocated empty dictionary. In the future, it is planned to extend this function to take optional arguments for initial key/values. Returns a newly allocated empty dictionary. In the future, it is planned to extend this function to take optional arguments for initial key/values.
(dictionary? obj) - *(dictionary? obj)*
^^^^^^^^^^^^^^^^^
Returns #t if obj is a dictionary. Returns #t if obj is a dictionary.
(dictionary-ref dict key) - *(dictionary-ref dict key)*
^^^^^^^^^^^^^^^^^^^^^^^^^
Look up dictionary dict for a value associated with symbol key. If no object is associated with key, it will raise an error. Look up dictionary dict for a value associated with symbol key. If no object is associated with key, it will raise an error.
(dictionary-set! dict key obj) - *(dictionary-set! dict key obj)*
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If there is no value already associated with key, this function newly creates a binding of key with obj. Otherwise, updates the existing binding with given obj. If there is no value already associated with key, this function newly creates a binding of key with obj. Otherwise, updates the existing binding with given obj.
(dictionary-delete dict key) - *(dictionary-delete dict key)*
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Deletes the binding associated with key from dict. If no binding on dict is associated with key, an error will be raised. Deletes the binding associated with key from dict. If no binding on dict is associated with key, an error will be raised.
- *(dictionary-size dict)*
(dictionary-size dict)
^^^^^^^^^^^^^^^^^^^^^^
Returns the number of registered elements in dict. Returns the number of registered elements in dict.
(picrin user) (picrin user)
------------- -------------