on master help sign in
update developer doc generation
d0ef2baHarendra Kumar
CONTRIBUTING.md+9−4
@@ -131,10 +131,15 @@ their existing code to the new change.
131
131
132## Developer documentation
132## Developer documentation
133
133
134−Build haddock with the `--show-all` option to see the documentation for all
135−modules including the ones not exposed to users of the library.
134+To build haddock documentation for all modules, including the ones not exposed
136−For example,
135+to users of the library, use the following commands:
136+
137+```
138+$ cabal v2-haddock --haddock-internal
137−`stack haddock --haddock-arguments "--show-all" --no-haddock-deps`.
139+$ stack haddock --haddock-arguments "--show-all" --no-haddock-deps
140+```
141+
142+For design documentation see the `design` directory.
138
143
139## Coding
144## Coding
140
145