Update Readme.md

testit-tms · Oct 9, 2023 · 038a1ee · 038a1ee
1 parent cf561ab
commit 038a1ee
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/testit-adapter-testng/Readme.md b/testit-adapter-testng/Readme.md
@@ -222,13 +222,13 @@ Use annotations to specify information about autotest.
 
 Description of annotations:
 
-- `WorkItemIds` - linking an autotest to a test case.
-- `DisplayName` - name of the autotest in Test IT.
-- `ExternalId` - ID of the autotest within the project in Test IT.
-- `Title` - title in the autotest card and the step.
-- `Description` - description in the autotest card and the step.
-- `Labels` - tags in the autotest card.
-- `Links` - links in the autotest card.
+- `WorkItemIds` - a method that links autotests with manual tests. Receives the array of manual tests' IDs
+- `DisplayName` - internal autotest name (used in Test IT)
+- `ExternalId` - unique internal autotest ID (used in Test IT)
+- `Title` - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
+- `Description` - autotest description specified in the autotest card
+- `Labels` - tags listed in the autotest card
+- `Links` - links listed in the autotest card
 - `Step` - the designation of the step.
 - `Classname` - name of the classname.
 - `Namespace` - name of the package.