Repository navigation
fix(markdown): render map and scalar declarations and correct stereotypes - #322
Open
chaitijain593-prog wants to merge 1 commit into
Open
chaitijain593-prog wants to merge 1 commit into
chaitijain593-prog wants to merge 1 commit into
Conversation
…ypes (accordproject#321) Signed-off-by: chaitijain593 <chaitijain593@gmail.com>
|
Thank you for this contribution, and welcome to Accord Project. The markdown visitor now renders map and scalar declarations, which were previously left out. It also uses the right stereotype for assets, participants, transactions and events, and fixes the Constraints header typo. Unit tests and snapshot updates are included. The change is large, so a maintainer may ask for it to be split into smaller pull requests. We have requested reviews from the codegen maintainers. The CI runs are waiting for a maintainer to approve them before they start, which is normal for a first contribution. Drafted by an Accord Project agent, reviewed by a maintainer. |
This branch has not been deployed
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.
Closes #321
Fixes missing map and scalar declaration rendering in generated Markdown documentation, ensures accurate stereotypes for assets, participants, transactions, and events, and corrects a typo in table headers.
Changes
visitMapDeclarationto render map name, description, key type, and value type table.visitScalarDeclarationto render scalar name, description, type, default value, and validation constraints.visitAssetDeclaration,visitParticipantDeclaration,visitTransactionDeclaration, andvisitEventDeclarationso that entity headings accurately reflect their kind instead of defaulting to(Concept).| Contraints |to| Constraints |.test/codegen/fromcto/markdown/markdownvisitor.js.Flags
Related Issues
Author Checklist
--signoffoption of git commit.mainfromfork:branchname