Skip to content

Commit e679acc

Browse files
Private1647Ishavyas9
authored andcommitted
Update kane-ai-using-variables.md with {{ instead of $
1 parent 1ff988c commit e679acc

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

docs/kane-ai-using-variables.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,36 +53,30 @@ Using variables enables you to:
5353
## Variable Syntax
5454
To work with variables in KaneAI, you need to follow these syntax rules:
5555

56-
- Variables are defined using the `$` prefix
57-
- Variable names should follow the `$` symbol without any spaces
58-
- Example: `$username`, `$phoneNumber`, `$address`
56+
- Variables are defined using natural language such as "set new_variable as value".
57+
- Variable usage can be done using the `{{` prefix to list all existing variables.
58+
- Example: `{{username}}`, `{{phoneNumber}}`, `{{address}}`
5959

6060
## Creating Variables
6161
To create a variable:
6262

6363
- Navigate to the "Write a Step" text field
64-
- Type your instruction in natural language such as: *Set username as John* and a variable `$username` will be created with value John.
64+
- Type your instruction in natural language such as: *Set username as John* and a variable `{{username}}` will be created with value John.
6565

6666
Example:
6767
```bash
6868
Set username as John
6969
```
7070

7171
## Using Variables
72-
To use a previously created variable in any subsequent step or test case, reference the variable using the same `$` syntax. Format: *use the value of `$variableName`*
72+
To use a previously created variable in any subsequent step or test case, reference the variable using the same `{{` syntax. This will list down all existing variables for this test. Format: *use the value of `{{variableName}}`*
7373

7474
Example:
7575
```bash
76-
use the value of $phoneNumber in the given text field
76+
use the value of {{phoneNumber}} in the given text field
7777
```
78-
<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/variables/1.png').default} alt="kenai-jira integration" className="doc_img"/>
7978

8079
## Best Practices
8180
### Naming Conventions
8281
- Use descriptive names for your variables
83-
- Avoid special characters except for the required $ prefix
84-
- Use camelCase for multi-word variable names
85-
86-
### Variable Management
87-
- Document the purpose of each variable in comments
88-
- Verify that variables are defined before using them
82+
- Use camelCase or underscore for multi-word variable names

0 commit comments

Comments
 (0)