docstrings: Docstrings for documentation in the repl

[ documentation, library, mit ] [ Propose Tags ]

This package provides docstring funcionality similar to Python or Lisp. Docstrings are simply strings bound to identifier names. To get access to a name one must enable -XTemplateHaskell and use prime notation like 'myValIdentifier and ''MyTypeIdentifier. Access Docstrings in the repl via help 'myIdentifier, and introduce Docstrings via docstring 'myIdentifier "some documentation" in a module.


[Skip to Readme]
Versions 0.1.0.0
Dependencies base (>=4.7 && <5), containers, heredoc, template-haskell [details]
License MIT
Copyright 2017 Dai
Author Dai
Maintainer dailectic@gmail.com
Category Documentation
Home page https://github.com/daig/docstrings#readme
Source repo head: git clone https://github.com/daig/docstrings
Uploaded by dailectic at Fri Nov 10 22:20:14 UTC 2017
Distributions NixOS:0.1.0.0
Downloads 275 total (13 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-11-10 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for docstrings-0.1.0.0

[back to package description]

docstrings

This package provides <https://en.wikipedia.org/wiki/Docstring docstring> funcionality similar to Python or Lisp. Docstrings are simply strings bound to identifier names. To get access to a name one must enable @-XTemplateHaskell@ and use prime notation like @'myValIdentifier@ and @''MyTypeIdentifier@. Access Docstrings in the repl via @help 'myIdentifier@, and introduce Docstrings via @docstring 'myIdentifier "some documentation"@ in a module.