Drasil icon indicating copy to clipboard operation
Drasil copied to clipboard

Haddock Documentation Subsection Headers

Open Ant13731 opened this issue 3 years ago • 2 comments

Although #2477 isn't quite finished yet, I think it might be good (at least for drasil-lang) to include Haddock subsection headers (I already did so for the drasil-website package). This shouldn't take nearly as long as #2477 since most of the files have the needed comments, they just need to be implemented by using -- * instead of just --. This would also be useful to link to specific subsections from the Wiki.

Progress list:

  • [x] drasil-build
  • [ ] drasil-code-base
  • [ ] drasil-code
  • [x] drasil-data
  • [x] drasil-database
  • [x] drasil-docLang
  • [ ] drasil-example
  • [x] drasil-gen
  • [ ] drasil-gool (skip this one for now)
  • [x] drasil-lang
  • [x] drasil-metadata
  • [x] drasil-printers
  • [x] drasil-theory
  • [x] drasil-utils
  • [x] drasil-website

Ant13731 avatar Jul 30 '21 13:07 Ant13731

That's really neat!

Would this be a good new standard for sectioning code inside of modules?

balacij avatar Jul 30 '21 15:07 balacij

Yes, the subsection headers are a nice organizational addition.

smiths avatar Jul 30 '21 15:07 smiths