Add notes to template code
Changes:
- Added comments and minor code changes layout
Tested:
- NA
Change-Id: I7617e2e31fec7395e0f7895256905b2878a180c8
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/templates/pgm_template.robot b/templates/pgm_template.robot
index 0231357..2acb339 100755
--- a/templates/pgm_template.robot
+++ b/templates/pgm_template.robot
@@ -1,7 +1,10 @@
*** Settings ***
-# Copy this template as a base to get a start on a robot program. You may remove any generic comments (like
-# this one).
+# Copy this template as a base to get a start on a robot program.
+# You may remove any generic comments (like this one).
+
+# Note: This is a template base code structure and not meant to
+# work as it is directly without modification.
Documentation Base to get a start on a robot program.
@@ -11,6 +14,7 @@
Library gen_robot_valid.py
Resource bmc_redfish_resource.robot
+# Write your own keyword(s) for setup and teardown
Suite Setup Suite Setup
Suite Teardown Suite Teardown
Test Setup Test Setup
@@ -29,5 +33,6 @@
*** Test Cases ***
Test Case 1
[Documentation] Test case 1 documentation.
+ [Tags] Test_Case_1
- Qprint Timen First test case.
+ Log To Console First test case.