Skip to content

Improve documentation #2

@snunez1

Description

@snunez1

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions