-
Notifications
You must be signed in to change notification settings - Fork 123
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
Add documentation for :dumptests via a new section in the High Assurance chapter of Programming in Cryptol Book #1760
Conversation
…ramming Cryptol book for generating test vectors using :dumptests. An example is also given using SHA2 256.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this! I have a few questions & clarifications.
…ol specs. Keep example as a polymporphic function using multiple inputs and a non Bit output to show that it can handle that case now. Also fix up some minor typos and clarify a few sentences.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here are some nitpicky little suggestions on wording
:dumptests <results file> <function> | ||
:dumptests results.txt myFunction | ||
\end{Verbatim} | ||
The results file will contain a tab delimited file in which the first column contains the output, and each column after contains the inputs to the function in order. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggested rephrase: "tab delimited file" -> "tab delimited table"? I don't love the phrasing of "the file contains a file" but I'm struggling to find a better word.
Use different size output to reiterate that the output is first in the results of :dumptests. Some minor rewording and wordsmithing.
cb374c3
to
75a61ec
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for iterating!
Closes #611