Document vast majority of protocol messages #46
Merged
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
jcspencer
force-pushed
the
jcspencer/documentation
branch
2 times, most recently
from
c31470a to
1838cf7
Compare
|
Wow, really awesome job! 🎉 I'll read it carefully but it looks so good that it's hard to resist pressing "Merge pull request" right now! 😬 |
wiktor-k
approved these changes
Apr 18, 2024
There was a problem hiding this comment.
Okay, this looks very good! A couple more of these doc comments and we'd be able to turn on #![deny(missing_docs)] 😅
I think the plan forward would be to get #48 merged first, then this PR may be rebased on top of main, adjusting for the changes and then we merge this.
Thank you!
wiktor-k
added a commit
that referenced
this pull request
Apr 18, 2024
See: #46 (comment) Signed-off-by: Wiktor Kwapisiewicz <[email protected]>
|
Okay, I see just minor formatting things being wrong here so if you don't mind I'll fix it and merge this PR... if there's anything to adjust later we can do it in a subsequent PRs :) |
Signed-off-by: James Spencer <[email protected]>
wiktor-k
force-pushed
the
jcspencer/documentation
branch
from
25fc116 to
908ff84
Compare
|
Thanks! |
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 PR adds documentation for the structures in the
protomodule with references back to the agent protocol specification.I'll come back later and add top-level documentation for these modules.
I've held off on documenting the
agentmodule as it's undergoing a bit of renovation at the moment!I've tried to say as close to the specification with this documentation, but have added some simplifications of the spec in some places, so very open to feedback / nits :^)