lightyear icon indicating copy to clipboard operation
lightyear copied to clipboard

Published 20 hours ago • verified publisher icon ziman

documentation

Open langston-barrett opened this issue 9 years ago • 3 comments
trafficstars

Is there any documentation available for this library?

langston-barrett avatar Sep 27 '16 02:09 langston-barrett

Looks like there's IdrisDoc, which I just learned about :-) might be helpful to point newbies in that direction!

langston-barrett avatar Sep 27 '16 03:09 langston-barrett

@siddharthist mind dropping the link here?

leostera avatar Mar 29 '17 00:03 leostera

@ostera You will be interested in:

  • http://idris.readthedocs.io/en/latest/reference/documenting.html
  • https://github.com/idris-lang/Idris-dev/wiki/Unofficial-FAQ#is-there-some-documentation-for-the-standard-lib-list-of-functions

When installing idris packages you can also innvoke: idris --installdoc <pkg name> that will install the documentation for he package (html) into idris --docdir. Or idris --mkdoc <pkg name> that will dump the documentation into the project's root. All the documentation in the generate docs are accessible from Idris' REPL, and various IDE mode's.

Any question's please feel free to lurk in #idris on freenode, or send a question to the mailing list.

jfdm avatar Mar 29 '17 08:03 jfdm