JacquesCarette / Drasil

Generate all the things (focusing on research software)
https://jacquescarette.github.io/Drasil
BSD 2-Clause "Simplified" License
141 stars 26 forks source link

Haddock Documentation Subsection Headers #2753

Open Ant13731 opened 3 years ago

Ant13731 commented 3 years ago

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:

balacij commented 3 years ago

That's really neat!

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

smiths commented 3 years ago

Yes, the subsection headers are a nice organizational addition.