Skip to content
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

Open
gheber opened this issue Jul 2, 2015 · 7 comments
Open

Add documentation strings #19

gheber opened this issue Jul 2, 2015 · 7 comments
Assignees

Comments

@gheber
Copy link
Owner

gheber commented Jul 2, 2015

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 gheber self-assigned this Jul 2, 2015
@gheber gheber added this to the Documentation milestone Jul 2, 2015
@gheber
Copy link
Owner Author

gheber commented Jul 3, 2015

combinations.lisp done.

@dimpase
Copy link
Collaborator

dimpase commented Jul 12, 2015

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

@gheber
Copy link
Owner Author

gheber commented Jul 12, 2015

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

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

@gheber
Copy link
Owner Author

gheber commented Jul 12, 2015

See 32c2ab2.

@gheber
Copy link
Owner Author

gheber commented Jul 13, 2015

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
Copy link
Owner Author

gheber commented Aug 3, 2015

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

@gheber
Copy link
Owner Author

gheber commented Aug 16, 2015

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants