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

Some node names break the diagrams #1444

Closed
italomaia-bk opened this issue Jun 5, 2020 · 4 comments · Fixed by #1492
Closed

Some node names break the diagrams #1444

italomaia-bk opened this issue Jun 5, 2020 · 4 comments · Fixed by #1492

Comments

@italomaia-bk
Copy link

Describe the bug
Tried to have a flowchart node called "end". It breaks flowchart.

To Reproduce

graph TD
  start --> state
  state --> end

Expected behavior
Should produce diagram

Desktop (please complete the following information):

  • Testted on vscode markdown preview
@italomaia-bk italomaia-bk added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Jun 5, 2020
@GDFaber
Copy link
Member

GDFaber commented Jun 5, 2020

Hi @italomaia-bk, this is due to the markup language approach which mermaid is built upon. But you can give the node another id and still use "end" for its caption text: example in the live editor.

@italomaia-bk
Copy link
Author

italomaia-bk commented Jun 5, 2020

Yeah, I'm using this workaround.
If this limitation is expected and not documented, we might still have an issue.

@GDFaber
Copy link
Member

GDFaber commented Jun 5, 2020

It should be helpful to have a list in the documentation which includes all the words reserved for syntax for every diagram type.

@GDFaber GDFaber added Area: Documentation Good first issue! Type: Enhancement New feature or request and removed Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Jun 5, 2020
@NeilCuzon
Copy link
Member

I submitted a PR for this, but I found that "End" also breaks sequence diagrams.

@github-actions github-actions bot locked and limited conversation to collaborators Jun 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants