marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-02 23:26:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore(sequence): update doc for actors/participant creation/deletion fix

Browse Source
This commit is contained in:
Faris Nabiev
2023-10-13 12:07:36 +03:00
parent 6eae46b927
commit fc0ade2985
3 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cypress/integration/rendering/sequencediagram.spec.js
View File

@@ -930,7 +930,7 @@ context('Sequence diagram', () => {
});
});
});
context('db clear', () => {
context('render after error', () => {
it('should render diagram after fixing destroy participant error', () => {
cy.on('uncaught:exception', (err) => {
return false;

8
docs/syntax/sequenceDiagram.md
View File

@@ -131,6 +131,14 @@ sequenceDiagram
Bob->>Alice: I agree
```
#### Unfixable actor/participant creation/deletion error (v\<MERMAID_RELEASE_VERSION>+)
If an error of the following type occurs when creating or deleting an actor/participant:
> The destroyed participant **participant-name** does not have an associated destroying message after its declaration. Please check the sequence diagram.
And fixing diagram code does not get rid of this error and rendering of all other diagrams results in the same error, then you need to update the mermaid version.
### Grouping / Box
The actor(s) can be grouped in vertical boxes. You can define a color (if not, it will be transparent) and/or a descriptive label using the following notation:

8
packages/mermaid/src/docs/syntax/sequenceDiagram.md
View File

@@ -83,6 +83,14 @@ sequenceDiagram
Bob->>Alice: I agree
```
#### Unfixable actor/participant creation/deletion error (v<MERMAID_RELEASE_VERSION>+)
If an error of the following type occurs when creating or deleting an actor/participant:
> The destroyed participant **participant-name** does not have an associated destroying message after its declaration. Please check the sequence diagram.
And fixing diagram code does not get rid of this error and rendering of all other diagrams results in the same error, then you need to update the mermaid version.
### Grouping / Box
The actor(s) can be grouped in vertical boxes. You can define a color (if not, it will be transparent) and/or a descriptive label using the following notation: