Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ErDiagram] Allow comments on whole entity #5878

Open
Hugofbf21 opened this issue Sep 19, 2024 · 1 comment
Open

[ErDiagram] Allow comments on whole entity #5878

Hugofbf21 opened this issue Sep 19, 2024 · 1 comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request

Comments

@Hugofbf21
Copy link

Proposal

Hello Mermaid team,
I would like to request a new feature for the ER diagram syntax in Mermaid.js. Currently, it is possible to add comments to individual attributes within an entity, but there is no syntax to comment on the entire entity itself. This feature would be very useful for providing high-level descriptions or notes about the entity as a whole.

Example

Proposed Syntax: I propose adding a new syntax to allow comments at the entity level.
For example:
erDiagram
Dog {
%% This is a comment for the entire Dog entity
uuid PK
varchar(50) name
varchar(100) owner
}

This would render a separate line with a box with the comment

Screenshots

No response

@Hugofbf21 Hugofbf21 added Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request labels Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants
@Hugofbf21 and others