Bump argo submodule to include docs for method results #1207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This bumps the `argo` submodule to include commit GaloisInc/argo@b9b3edd, which adds the ability to document the results of methods (in addition to their parameters). In addition to dealing with the breaking API changes from that commit, this adds missing documentation for each method's results.
RyanGlScott
added
docs
pnwamk
reviewed
Jun 1, 2021
Unfortunately, the autogenerated documentation (now located in `Cryptol.rst`) doesn't yet have all of the information contained within the hand-written documentation (now located in `old-Cryptol.rst`—see #1206. In pursuit of eventually fixing that issue, the CI now makes sure that any changes to the autogenerated documentation are checked in.
pnwamk
approved these changes
Jun 1, 2021
There was a problem hiding this comment.
LGTM!
While perusing the docs I discovered some issues but I think they're probably just better addressed separately instead of holding up this PR.
In particular, some of Argo's docs need updating: GaloisInc/argo#166
And perhaps it's worth considering generating something more polished from the .rst: #1208
RyanGlScott
added a commit
to GaloisInc/saw-script
that referenced
this pull request
Jun 8, 2021
This bumps the `argo` submodule to include commit GaloisInc/argo@b9b3edd, which adds the ability to document the results of methods (in addition to their parameters). In addition to dealing with the breaking API changes from that commit, this adds missing documentation for each method's results. This also requires bumping the `cryptol` submodule commit to bring in similar changes introduced in GaloisInc/cryptol#1207.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This follows up on a promise I made in #1196 (comment) to bump the
argosubmodule to includeargocommit GaloisInc/argo@b9b3edd, which adds the ability to document the results of methods (in addition to their parameters). In addition to dealing with the breaking API changes from that commit, this adds missing documentation for each method's results.Along the way, I realized that
cryptol-remote-api's documentation is hand-written rather than autogenerated (see #1206). In pursuit of eventually fixing that issue, the CI now makes sure that any changes to the autogenerated documentation are checked in.