Adding pydocs

Author: kumar-shivam-ranjan

ads/aqua/extension/ui_handler.py

@@ -107,10 +107,12 @@ def list_log_groups(self, **kwargs):
             AquaUIApp().list_log_groups(compartment_id=compartment_id, **kwargs)
         )
 
-    def is_capacity_reservations_enabled(self, **kwargs):
+    def is_capacity_reservations_enabled(self):
+        """Checks if the tenant is whitelisted for BYOR (Bring your own reservation) feature."""
         return self.finish({"status": str(IS_BYOR_ENABLED).strip().lower() == "true"})
 
     def list_capacity_reservations(self, **kwargs):
+        """Lists users compute reservations in a specified compartment."""
         compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
         return self.finish(
             AquaUIApp().list_capacity_reservations(

ads/aqua/ui.py

@@ -91,12 +91,20 @@ def list_logs(self, **kwargs) -> str:
         return sanitize_response(oci_client=self.logging_client, response=res)
 
     @telemetry(entry_point="plugin=ui&action=list_capacity_reservations", name="aqua")
-    def list_capacity_reservations(self, **kwargs):
+    def list_capacity_reservations(self, **kwargs) -> list:
+        """
+        Lists users compute reservations in a specified compartment
+
+        Returns
+        -------
+            json representation of `oci.core.models.ComputeCapacityReservationSummary`.
+
+        """
         compartment_id = kwargs.pop("compartment_id", COMPARTMENT_OCID)
         logger.info(f"Loading Capacity reservations from compartment: {compartment_id}")
         compute_client = oc.OCIClientFactory(**default_signer()).compute
         reservations = compute_client.list_compute_capacity_reservations(
-            compartment_id=compartment_id
+            compartment_id=compartment_id, **kwargs
         )
         return reservations.data