feat(api): change doc

AntaresSimulatorTeam · Dec 17, 2024 · b1229b6 · b1229b6
1 parent f1e11fa
commit b1229b6
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/src/antares/model/study.py b/src/antares/model/study.py
@@ -373,7 +373,7 @@ def wait_job_completion(self, job: Job, time_out: int = 172800) -> None:
 
     def read_outputs(self) -> list[Output]:
         """
-        Get outputs for current study
+        Load outputs into current study
 
         Returns: Output list
         """
@@ -382,9 +382,22 @@ def read_outputs(self) -> list[Output]:
         return outputs
 
     def get_outputs(self) -> dict[str, Output]:
+        """
+        Get outputs of current study
+
+        Returns: (output_id, Output) dictionary
+        """
         return self._outputs.copy()
 
     def get_output(self, output_id: str) -> Optional[Output]:
+        """
+        Get a specific output
+
+        Args:
+            output_id: id of the output to get
+
+        Returns: Output with the output_id
+        """
         return self._outputs.get(output_id)