[component]: Fix review comments.

Signed-off-by: Nazarii Hnydyn <nazariig@mellanox.com>
sonic-net · Apr 30, 2020 · d96344e · d96344e
1 parent b066ec7
commit d96344e
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/sonic_platform_base/component_base.py b/sonic_platform_base/component_base.py
@@ -34,6 +34,8 @@ def get_firmware_version(self):
         """
         Retrieves the firmware version of the component
 
+        Note: the firmware version will be read from HW
+
         Returns:
             A string containing the firmware version of the component
         """
@@ -43,6 +45,8 @@ def get_available_firmware_version(self, image_path):
         """
         Retrieves the available firmware version of the component
 
+        Note: the firmware version will be read from image
+
         Args:
             image_path: A string, path to firmware image
 
@@ -67,11 +71,11 @@ def get_firmware_update_notification(self, image_path):
 
     def install_firmware(self, image_path):
         """
-        Installs firmware to the component.
+        Installs firmware to the component
 
         This API performs firmware installation only: this may/may not be the same as firmware update.
         In case platform component requires some extra steps (apart from calling Low Level Utility)
-        to load the installed firmware (e.g, reboot, power cycle, etc.) - this must be done manually by user.
+        to load the installed firmware (e.g, reboot, power cycle, etc.) - this must be done manually by user
 
         Note: in case immediate actions are required to complete the component firmware update
         (e.g., reboot, power cycle, etc.) - will be done automatically by API and no return value provided
@@ -86,11 +90,11 @@ def install_firmware(self, image_path):
 
     def update_firmware(self, image_path):
         """
-        Updates firmware of the component.
+        Updates firmware of the component
 
         This API performs firmware update: it assumes firmware installation and loading in a single call.
-        In case platform componet requires some extra steps (apart from calling Low Level Utility)
-        to load the installed firmware (e.g, reboot, power cycle, etc.) - this will be done automatically by API.
+        In case platform component requires some extra steps (apart from calling Low Level Utility)
+        to load the installed firmware (e.g, reboot, power cycle, etc.) - this will be done automatically by API
 
         Args:
             image_path: A string, path to firmware image