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.

Sign up for GitHub

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

Add node naming rules #107

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add node naming rules #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/creating-nodes/appearance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,16 @@ it can be set dynamically on a per-node basis according to the nodes properties.
The value of the property can be either a string or a function.

If the value is a string, that is used as the label.
Use one of the following formats when naming nodes.

- Verb only (e.g. "update")
- Noun only (e.g. "server status")
- Verb + noun (e.g. "stop job")

Keep the following in mind:

- Words must begin with a lower-case letter.
- Use one single-byte space between words.

If the value is a function, it will get evaluated when the node is first loaded,
or after it has been edited. The function is expected to return the value to use
Expand Down