Skip to content

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

@chdoc

Description

@chdoc

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions