Add missing description for arguments
Changes
Add missing description for arguments
Tested
NA
Change-Id: I4ce2100e0c19edda024aa4d4c4d194e681303b84
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>
diff --git a/extended/standby_bmc.robot b/extended/standby_bmc.robot
index 478ab17..2c27d20 100644
--- a/extended/standby_bmc.robot
+++ b/extended/standby_bmc.robot
@@ -116,6 +116,9 @@
[Documentation] Update the given restore policy
[Arguments] ${policy}
+ # Description of argument(s):
+ # policy Restore policy.
+
${valueDict}= create dictionary data=${policy}
Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
@@ -144,6 +147,9 @@
[Documentation] Parse the journal log and check for failures.
[Arguments] ${error_regex}=${ERROR_REGEX}
+ # Description of argument(s):
+ # error_regex Regex error pattern to be checked in the journal log.
+
${error_regex}= Escape Bash Quotes ${error_regex}
${journal_log} ${stderr} ${rc}= BMC Execute Command
... journalctl -b --no-pager | egrep '${error_regex}' ignore_err=1
@@ -153,6 +159,7 @@
Validate Parameters
[Documentation] Validate PDU parameters.
+
Should Not Be Empty ${PDU_IP}
Should Not Be Empty ${PDU_TYPE}
Should Not Be Empty ${PDU_SLOT_NO}
diff --git a/ipmi/dcmi/test_dcmi_asset_tag.robot b/ipmi/dcmi/test_dcmi_asset_tag.robot
index 1b0f3ea..b77916f 100644
--- a/ipmi/dcmi/test_dcmi_asset_tag.robot
+++ b/ipmi/dcmi/test_dcmi_asset_tag.robot
@@ -18,6 +18,7 @@
Set Asset Tag With Valid String Length
[Documentation] Set asset tag with valid string length and verify.
[Tags] Set_Asset_Tag_With_Valid_String_Length
+
# Allowed MAX characters length for asset tag name is 63.
${random_string}= Generate Random String 63
Run Keyword Run IPMI Standard Command dcmi set_asset_tag ${random_string}
@@ -29,6 +30,7 @@
Set Asset Tag With Invalid String Length
[Documentation] Verify error while setting invalid asset tag via IPMI.
[Tags] Set_Asset_Tag_With_Invalid_String_Length
+
# Any string more than 63 character is invalid for asset tag.
${random_string}= Generate Random String 64
@@ -129,6 +131,9 @@
[Documentation] Get response length in hex.
[Arguments] ${resp_length}
+ # Description of argument(s):
+ # resp_length Response data info.
+
${length}= Convert To Hex ${resp_length}
${length_1}= Get Length ${length}
${length_2}= Set Variable IF
diff --git a/ipmi/dcmi/test_dcmi_get_temperature_reading.robot b/ipmi/dcmi/test_dcmi_get_temperature_reading.robot
index eacd3e4..26b1760 100644
--- a/ipmi/dcmi/test_dcmi_get_temperature_reading.robot
+++ b/ipmi/dcmi/test_dcmi_get_temperature_reading.robot
@@ -25,6 +25,7 @@
&{dcmi_sensor_uri}
*** Test Cases ***
+
Verify Get Temperature Reading Command For Inlet Temperature Sensor
[Documentation] Verify IPMI Get Temperature Reading command for inlet temperature sensor.
[Tags] Verify_Get_Temperature_Reading_Command_For_Inlet_Temperature_Sensor
@@ -125,8 +126,9 @@
[Arguments] ${key} ${instance} ${dcmi_reading_value}
# Description of argument(s):
- # key Entity ID description i.e inlet, cpu, baseboard.
- # instance instance number 1, 2, ..
+ # key Entity ID description i.e inlet, cpu, baseboard.
+ # instance instance number 1, 2, ..
+ # dcmi_reading_value DCMI reading value.
${dbus_uris}= Get From Dictionary ${dcmi_sensor_uri} ${key}
${dbus_uri}= Get From Dictionary ${dbus_uris} ${instance}
diff --git a/network/test_vlan_network.robot b/network/test_vlan_network.robot
index c884100..3738d27 100644
--- a/network/test_vlan_network.robot
+++ b/network/test_vlan_network.robot
@@ -344,8 +344,9 @@
[Arguments] ${vlan_id} ${vlan_ip} ${expected_result}=valid
# Description of argument(s):
- # vlan_id The VLAN ID (e.g. '53').
- # vlan_ip The VLAN IP (e.g. 'x.x.x.x').
+ # vlan_id The VLAN ID (e.g. '53').
+ # vlan_ip The VLAN IP (e.g. 'x.x.x.x').
+ # expected_result Expected status to check existence of VLAN IP URI. (e.g. 'valid')
${vlan_records}= Read Properties
... ${NETWORK_MANAGER}eth0_${vlan_id}${/}enumerate quiet=1
@@ -371,7 +372,7 @@
[Arguments] ${id} ${interface}=eth0 ${expected_result}=valid
# Description of argument(s):
- # id The VLAN ID (e.g. id:'53').
+ # id The VLAN ID (e.g. id:'53').
# interface Physical Interface on which the VLAN is defined.
# expected_result Expected status to check existence or non-existence of VLAN.
diff --git a/oem/nuvoton/test_redfish_mcu_fw_update.robot b/oem/nuvoton/test_redfish_mcu_fw_update.robot
index e6c01b9..8d2ef0f 100644
--- a/oem/nuvoton/test_redfish_mcu_fw_update.robot
+++ b/oem/nuvoton/test_redfish_mcu_fw_update.robot
@@ -87,7 +87,8 @@
[Arguments] ${apply_time} ${image_file_path}
# Description of argument(s):
- # policy ApplyTime allowed values (e.g. "OnReset", "Immediate").
+ # policy ApplyTime allowed values (e.g. "OnReset", "Immediate").
+ # image_file_path Path to the image tarball.
Redfish.Login
@@ -112,4 +113,7 @@
[Documentation] Get image ID from image_info.
[Arguments] ${image_info}
+ # Description of argument(s):
+ # image_info Image info.
+
RETURN ${image_info["image_id"]}