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

Entity Relationship Diagram documentation bug #2653

Closed
ChloeLiang opened this issue Jan 21, 2022 · 2 comments
Closed

Entity Relationship Diagram documentation bug #2653

ChloeLiang opened this issue Jan 21, 2022 · 2 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect

Comments

@ChloeLiang
Copy link

Describe the bug

  1. The document says using double quotes for comment. I think it's not true.
  2. The diagram UI is not rendered correctly.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram?id=attribute-keys-and-comments
  2. It says And a comment is defined by double quotes at the end of an attribute.. I expect the comment not to render, but it is.
  3. See the diagram.

Expected behavior

  1. Comment is not rendered.
  2. Diagram is displayed correctly.

Screenshots
image

Desktop (please complete the following information):

  • Browser: Chrome
@ChloeLiang ChloeLiang added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Jan 21, 2022
@Arakade
Copy link

Arakade commented Jan 24, 2022

Is this a duplicate of #2548
I came here to report the same a similar thing. I took "comment" as "annotation" or "comment for the reader of the diagram". I think that's why it's rendered. I completely agree it's rendered incorrectly though!

@ChloeLiang
Copy link
Author

Hi @Arakade , you're right. It seems like a duplicate issue. I'll close this one. Thanks!

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: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

No branches or pull requests

2 participants