-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation strings #19
Comments
combinations.lisp done. |
yes, it's a great idea to document their abbreviations. |
I'll start with a wiki page and then add an A-LIST. https://github.com/gheber/kenzo/wiki/Abbreviations |
See 32c2ab2. |
Maybe we should take a look at https://github.com/didierverna/declt . It's not going to replace the user's guide, but it might make a better API reference. |
Use LISP-STAT-like documentation strings such as in commit c89b005. |
I think we need both of them: documentation strings and iPython notebooks. Documentation strings |
Give (documentation ...) a chance!
I'm also thinking of compiling a small list of the most commonly used abbreviations in the code, e.g.,
CMBN -> CoMBiNation, CFFC -> CoeFFiCient, ... Maybe as an a-list?
(pairlis '(cmbn "combination") '(cffc "coefficient") ...)
The text was updated successfully, but these errors were encountered: