kenzo icon indicating copy to clipboard operation
kenzo copied to clipboard

Add documentation strings

Open gheber opened this issue 10 years ago • 7 comments

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") ...)

gheber avatar Jul 02 '15 13:07 gheber

combinations.lisp done.

gheber avatar Jul 03 '15 16:07 gheber

yes, it's a great idea to document their abbreviations.

dimpase avatar Jul 12 '15 07:07 dimpase

I'll start with a wiki page and then add an A-LIST.

https://github.com/gheber/kenzo/wiki/Abbreviations

gheber avatar Jul 12 '15 14:07 gheber

See 32c2ab2.

gheber avatar Jul 12 '15 18:07 gheber

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.

gheber avatar Jul 13 '15 11:07 gheber

Use LISP-STAT-like documentation strings such as in commit c89b005.

gheber avatar Aug 03 '15 22:08 gheber

I think we need both of them: documentation strings and iPython notebooks. Documentation strings are the baseline and get you going when without the Handbook and iPython. It's less sophisticated than iPython notebooks, but that's no excuse for not having it.

gheber avatar Aug 16 '15 02:08 gheber