class diagrams: allow notes for namespace'd classes

[The-Alchemist]

Proposal

Short Description

...should improve its support for notes inside namespaces.

Example Syntax

The following example shows a note for a specific class inside a namespace. This syntax currently results in a parse error, Expecting CLASS, got NOTE_FOR:

classDiagram
namespace BaseShapes {

    note for Triangle "i am a note for Triangle"
    class Triangle
    class Rectangle {
      double width
      double height
    }
}

Loading

You can play with this syntax here on the playground.

Details

Technically, you can add a note for a namespaced class, but you have to place the note outside the namespace, and therefore, it renders outside the namespace.

classDiagram
namespace BaseShapes {

    class Triangle
    class Rectangle {
      double width
      double height
    }
}
note for Triangle "i am a note for Triangle"

Loading

The above diagram doesn't render in Github's viewer, but you can view it on the playground. It appears like this:

Example

classDiagram
namespace BaseShapes {

    note for Triangle "i am a note for Triangle"
    class Triangle
    class Rectangle {
      double width
      double height
    }
}

Screenshots

No response

[Adarsha186]

Hi @The-Alchemist, is this issue still open, I'm interested in doing open source contributions, if this issue is open can I take up this task.

[The-Alchemist]

Hi @The-Alchemist, is this issue still open, I'm interested in doing open source contributions, if this issue is open can I take up this task.

I think @kairi003 is working on it, or is done. See #5814

But please don't hesitate to pick up another task!

[kairi003]

@The-Alchemist Yes, the pr to resolve this issue is done. Now I am waiting for the merge, is there anything I can do for that?

[jgreywolf]

I am rerunning the tests to see if we get past the timeout failure there

[kairi003]

Error: You have reached the maximum screenshot capacity included in your Pro open source xl Plan. Please upgrade your Plan.
https://github.com/marketplace/argos-ci

@jgreywolf I tried re-running as well, but to no avail.
The message says reached the maximum screenshot capacity, but mermaid is already on the highest plan: XL.
I think we need to wait until December for the capacity to reset in order to pass the e2e tests.

[jgreywolf]

@sidharthv96 @ashishjain0512 @knsv @aloisklink Can one of you assist with this?