docs(reference): describe restrictions of a variable name #4411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
korthout
approved these changes
Apr 29, 2020
docs/src/reference/variables.md
Outdated
| * it must not start with a number | ||
| * it must not contain whitespaces | ||
| * it must not contain an operator (e.g. `+`, `-`, `*`, `/`, `=`, `>`, `?`, `.`) | ||
| * it must not be a literal (`null`, `true`, `false`) or a keyword (e.g. `function`, `if`, `then`, `else`, `for`, `between`, `instance`, `of`, `not`) |
There was a problem hiding this comment.
Suggested change
| * it must not be a literal (`null`, `true`, `false`) or a keyword (e.g. `function`, `if`, `then`, `else`, `for`, `between`, `instance`, `of`, `not`) | |
| * it must not be a literal (e.g. `null`, `true`, `false`) or a keyword (e.g. `function`, `if`, `then`, `else`, `for`, `between`, `instance`, `of`, `not`) |
docs/src/reference/variables.md
Outdated
| * it must not start with a number | ||
| * it must not contain whitespaces | ||
| * it must not contain an operator (e.g. `+`, `-`, `*`, `/`, `=`, `>`, `?`, `.`) | ||
| * it must not be a literal (`null`, `true`, `false`) or a keyword (e.g. `function`, `if`, `then`, `else`, `for`, `between`, `instance`, `of`, `not`) |
There was a problem hiding this comment.
I'm not entirely sure, but I'm wondering whether it may not contain x is better for these restrictions.
docs/src/reference/variables.md
Outdated
| @@ -2,6 +2,18 @@ | |||
|
|
|||
| Variables are part of a workflow instance and represent the data of the instance. A variable has a name and a JSON value. The visibility of a variable is defined by its variable scope. | |||
|
|
|||
| ## Variable Names | |||
|
|
|||
| The name of a variable can be any alphanumeric string including the `_` symbol. For a combination of words, it is recommended to use the `camelCase` or the `snake_case` format. | |||
There was a problem hiding this comment.
Perhaps we should additionally note here that kebab-case cannot be used, because it might be a common pitfall.
saig0
force-pushed
the
docs-variable-name
branch
from
f03b1ce
to
7563f21
Compare
|
@korthout , thank you for the fast review and the hints 👍 |
|
bors r+ |
zeebe-bors bot
added a commit
that referenced
this pull request
Apr 30, 2020
4411: docs(reference): describe restrictions of a variable name r=saig0 a=saig0 ## Description * avoid that users use an invalid name for a variable by describing how a variable name should look like ## Related issues none # Co-authored-by: Philipp Ossler <philipp.ossler@gmail.com>
Build failed |
|
bors retry |
Build succeeded |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related issues
none
Pull Request Checklist
mvn clean install -DskipTestslocally before committing