-
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
Modernize the README
slightly
#1543
Conversation
RyanGlScott
commented
Jul 6, 2023
- Mention version 3, not 2, of Cryptol. This fixes Version 2 -> Version 3 #1542
- Modernize the copyright years slightly
- Mention significant contributions from @qsctr, @Riib11, and @m-yac
Mention Bretton Chen, Henry Blanchette, and Matthew Yacavone, all of whom have made significant contributions. Also use Hazel Weakly's current name.
Woo! I think there is potential for improvement in the |
Are you referring to this sentence? Lines 181 to 182 in 57226ef
That is, would you like to see any accompanying document for changes between Cryptol 2 and 3? |
That's the sentence. There was support for the move from 1 -> 2...it would be nice to have a Version3Changes, similar to the existing Version2Changes. Also, adjacent documentation also needs to be updated, for example, the syntax guide doesn't mention the new module system. |
I think we may want to remove the "syntax guide". All the stuff in it should be in the reference manual---I used the syntax guide as the starting point for the reference manual. |
It's easy to forget to update this. In addition, the version number is specified elsewhere in the pyproject.toml file, so putting the version number in the description in redundant.
Because these are larger changes (and I don't want to hold up the rest of this PR on them), I have opened separate issues to track the remaining documentation suggestions:
|