8000 Improve documentation · Issue #2 · Lisp-Stat/statistics · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Improve documentation #2

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.

Sign up for GitHub

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

Jump to bottom
Open
snunez1 opened this issue Aug 20, 2022 · 4 comments
Open

Improve documentation #2

snunez1 opened this issue Aug 20, 2022 · 4 comments

Comments

@snunez1
Copy link
Contributor
snunez1 commented Aug 20, 2022

This issue is to track two potential improvements in documentation:

  • API reference
  • System manual

API Reference
Lisp-Stat uses declt to generate reference documentation from doc strings and output HTML, PDF, epub, etc. For example see the reference for data-frame. This doesn't work too well for statistics because either:

  1. There is no doc string
  2. The doc string is in a comment preceding the function.

System Manual
It seems that the majority of new users are not from the Common Lisp community and often they're not well versed in statistics either. If we look at other statistical computing systems, like Python, Julia or R, they have robust documentation, with plenty of examples. See the data frame system manual for an example.
@jgarte
Copy link
jgarte commented Jan 15, 2023

hi,

The home page also currently points to the main lisp-stat page instead of dedicated documentation:

https://lisp-stat.dev/docs/

@Symbolics
Copy link

Which link is pointing to the main page? The github main page?

@jgarte
Copy link
jgarte commented Jan 16, 2023

Search for "Explore the docs" here:

https://raw.githubusercontent.com/Lisp-Stat/statistics/master/README.md

@Symbolics
Copy link

Thanks, fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Symbolics @snunez1 @jgarte
0