Fix docstrings #108
Fix docstrings #108
Conversation
- Fixes docstrings to use correct notation and parameterization - Modifies AES spec to parameterize modules at import time instead of at use, to address an import sketchiness for running the docstrings - Adds a citation.
There was a problem hiding this comment.
LGTM, :check-docstring seems to be working well @glguy on these. One thing of note is for extremely large :check-docstring processes there is no notion if it is just hanging or taking a long time to compute. I know that this is an issue for any property check that takes a significant amount of time but this is a bit extended by the fact that all of the checks need to complete before output is produced. No action needed on this comment at the moment just something to note.
There was a problem hiding this comment.
Everything looks right except:
GC28.cryhas a couple of code fences usingcryptolinstead ofreplthat I think should be changed. I checked and those properties do pass unless that module is out of scope for things change.
These changes help demonstrate that it can be confusing to know which modules are functors and which are not and therefore which modules should be able to have their docstrings tested.
Closes #105.
This fixes some docstring checks and proves to use the correct notation, instead of an outdated version, and updates some comments about provability to actually have a proving docstring. It also cleans up some parameterized imports in AES that didn't need to be parameterized.