docs: fix getCreator and ProposalCreator type documentation#498
Merged
bestbeforetoday merged 1 commit intohyperledger:mainfrom Mar 11, 2026
Merged
docs: fix getCreator and ProposalCreator type documentation#498bestbeforetoday merged 1 commit intohyperledger:mainfrom
bestbeforetoday merged 1 commit intohyperledger:mainfrom
Conversation
Fixes hyperledger#308 Signed-off-by: Sourav <souravkjha2007@gmail.com>
bestbeforetoday
approved these changes
Mar 11, 2026
Member
bestbeforetoday
left a comment
There was a problem hiding this comment.
Thank you for the contribution.
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
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.
Description
This PR fixes the JSDoc documentation for the
getCreator()method and the submitter's identity object to accurately reflect the TypeScript definitions (SerializedIdentity) found infabric-shim-api.Previously, the JSDoc incorrectly referred to the identity object as an instantiable class named
ProposalCreatorand incorrectly listed the certificate bytes property asid_bytesinstead of the camelCasedidBytes.Changes Made:
ProposalCreatortoSerializedIdentityinlibraries/fabric-shim/lib/stub.js.id_bytestoidBytes.@classtag from the identity objecttypedefso it is no longer falsely documented as a constructible class.getCreator()return type and other relevant references (likeSignedProposalandSignatureHeader) to useSerializedIdentity.Related Issues
Fixes #308
Checklist: