graph-theory icon indicating copy to clipboard operation
graph-theory copied to clipboard

Consitently use documentation comments (** *) for explanations.

Open chdoc opened this issue 4 years ago • 0 comments
trafficstars

In order to obtain decently looking documentation, we should consistent in our use of comments and documentation:

  • documentation comments (** *) for everything that qualifies as explanation (rendered in highlighted boxes in the documentation).
  • regular comments (* *) for TODO and TOTHINK comments and the like, that are internal (rendered as greyed-out text)

(edit: comments inside proofs must always be regular comments, as documentation inside proofs messes up coqdocjs code folding)

chdoc avatar Dec 01 '20 12:12 chdoc