Updating documentation on notes for classes

I was confused by the documentation on notes for a specific class. Updated the wording slightly and added an example for clarity.
This commit is contained in:
Will-Low
2023-04-13 09:08:48 -07:00
committed by GitHub
parent 32d553a28f
commit 19363965ad

View File

@@ -403,10 +403,26 @@ click className href "url" "tooltip"
## Notes
It is possible to add notes on diagram using `note "line1\nline2"` or note for class using `note for class "line1\nline2"`
It is possible to add notes on the diagram using `note "line1\nline2"`. A note can be added for a specific class using `note for <CLASS NAME> "line1\nline2"`.
### Examples
```mmd
classDiagram
note "This is a general note"
note for MyClass "This is a note for a class"
class MyClass{
}
```
```mermaid
classDiagram
note "This is a general note"
note for MyClass "This is a note for a class"
class MyClass{
}
```
_URL Link:_
```mmd