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

Misleading doc statement about state diagram? #5472

Open
voroninp opened this issue Apr 19, 2024 · 4 comments
Open

Misleading doc statement about state diagram? #5472

voroninp opened this issue Apr 19, 2024 · 4 comments
Labels
Area: Documentation Contributor needed Status: Approved Is ready to be worked on Type: Bug / Error Something isn't working or is incorrect

Comments

@voroninp
Copy link

Description

There's a statement in the docs about state diagram:

You can not define transitions between internal states belonging to different composite states

Cannot I?

Steps to reproduce

Here's the diagram I created:

---
title: Global states of the app.
---
stateDiagram-v2
    notAccessible: App is not accessible
    accessible : App is accessible 

    state notAccessible {
        init: App initialization phase
        Stopping --> [*]
    }

    state accessible {
        Starting --> Running
        Running --> Suspending
        Suspending --> Suspended
        Suspended --> Starting
    }

    [*] --> init
    init --> Starting
    Running --> Stopping
    Suspended --> Stopping

And here's what I get:
image

Screenshots

No response

Code Sample

No response

Setup

  • Mermaid version: 10.9.0
  • Browser and Version: Chrome 123.0.6312.123

Suggested Solutions

Well, I'm happy it works =D
I'm simply confused by the documentation.

Additional Context

No response

@voroninp voroninp added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Apr 19, 2024
@nirname
Copy link
Contributor

nirname commented Jun 19, 2024

@voroninp Highly likely it was not updated. Feel free to fix documentation according current behaviour.

@nirname nirname added Contributor needed Status: Approved Is ready to be worked on Area: Documentation and removed Status: Triage Needs to be verified, categorized, etc labels Jun 19, 2024
@voroninp
Copy link
Author

@nirname , I am not 100% sure. I have experience when something was working because of the bug :-)

@nirname
Copy link
Contributor

nirname commented Jun 19, 2024

I am not 100% sure either, I am not so well aware of all the flowchart features, so that I could tell what exactly was meant by "composite state", could you please investigate it further?

@nirname nirname added Status: Pending Is not to be executed as it currently is and removed Status: Approved Is ready to be worked on labels Jun 19, 2024
@nirname
Copy link
Contributor

nirname commented Jun 19, 2024

It really seems that documentation is obsolete.

@nirname nirname added Status: Approved Is ready to be worked on and removed Status: Pending Is not to be executed as it currently is labels Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Contributor needed Status: Approved Is ready to be worked on Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

No branches or pull requests

2 participants