docs: document FixDescriptor struct fields and all project events in API reference - #7
Merged
rya-sge merged 1 commit intoMay 24, 2026
Conversation
…API reference Address Technical Committee feedback: the FixDescriptor struct fields (schemaHash, fixRoot, fixSBEPtr, fixSBELen, schemaURI) were used in code examples but never explained, and the project-defined events were missing from the API reference. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
FixDescriptorsubsection at the top of the API Reference, documenting all five fields (schemaHash,fixRoot,fixSBEPtr,fixSBELen,schemaURI) with types and descriptions.FixDescriptorEnginedocumentingFixDescriptorSetandFixDescriptorUpdated.FixDescriptorEngineModuledocumentingFixDescriptorEngineSet(added in v0.2.0).Addresses Technical Committee feedback that these were present in code examples but not explained in the README.
Test plan
IFixDescriptor.solstruct definitionMade with Cursor