Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
chdoc opened this issue Dec 1, 2020 · 0 comments
Open

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

chdoc opened this issue Dec 1, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@chdoc
Copy link
Member

chdoc commented Dec 1, 2020

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 chdoc added the documentation Improvements or additions to documentation label Dec 1, 2020
@chdoc chdoc modified the milestone: v0.8 Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant