search

smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

Reference Section Misplacement in GlassBR MIS #142

Closed samm82 closed 6 years ago

samm82 commented 6 years ago

The references section in the MIS comes after the Module Hierarchy instead of at the end of the document and doesn't show up in the table of contents.

refs

smiths commented 6 years ago

Different choices could certainly be made here, but I don't think what is currently done with the references is incorrect. The actual specifications are like an appendix to the document. The references apply for the "front-matter", so they are given at the beginning. The absence of a section number for the References section is the default LaTeX behaviour; I don't think we need to override that default.