GaloisInc / cryptol

Cryptol: The Language of Cryptography
https://galoisinc.github.io/cryptol/master/RefMan.html
BSD 3-Clause "New" or "Revised" License
1.14k stars 126 forks source link

Initial implementation of :check-docstrings #1682

Closed glguy closed 4 months ago

RyanGlScott commented 4 months ago

Could you write some documentation that describes how :check-docstrings works at a high level? The Cryptol reference manual might be one place to put this documentation, but if there isn't a good place in the manual to put it, even including the comments as just Haddocks would be nice. In particular, I think we should make note of things such as:

Some test cases that exercise the functionality of :check-docstrings would also be appreciated.

sauclovian-g commented 4 months ago

If there isn't a place in the manual to put it, feel free to stick it in an appendix marked something like "Additional notes to be merged", create another issue for sorting it out properly, and assign that to me. There should be a place for everything in the manual.