search

lapplislazuli / Hopinosis

Opinosis Implementation in Haskell
MIT License
0 stars 0 forks source link

Add Haddock #10

Closed lapplislazuli closed 4 years ago

lapplislazuli commented 4 years ago

At Haddock Documentation to the exposed functions of each module.

Proposed Solution See above

Possible Alternatives:

  1. Hadockify everthing
  2. Hadockify nothing

Possible Problems: Maybe I will still remove functions, then the docu will be wasted.

Atleast have it in place and everything running. In case i want to do more or less docu, its still nice to have it in the git history and have it done once.

Additional Context: Haddock readme: https://haskell-haddock.readthedocs.io/en/latest/index.html

lapplislazuli commented 4 years ago

Ref to Actual Syntax

And Module Description

lapplislazuli commented 4 years ago

Best Description: https://haskell-haddock.readthedocs.io/en/latest/markup.html

lapplislazuli commented 4 years ago

The only thing missing is adding it to my cabal build. This is suppossed to go like: 

> cabal new-build --enable-tests --enable-documentation

But I have no clue why it does not what I want.

lapplislazuli commented 4 years ago

This is the same problem, but for him the normal thing works and only base library does not work.