From 0756c9d6e84af9d0b94ecf80e039b6c879ee50ec Mon Sep 17 00:00:00 2001 From: trevorb1 Date: Tue, 15 Aug 2023 08:59:35 -0700 Subject: [PATCH] update ReadGlpk docstrings --- src/otoole/results/results.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/src/otoole/results/results.py b/src/otoole/results/results.py index d06a79a5..15ec93c6 100644 --- a/src/otoole/results/results.py +++ b/src/otoole/results/results.py @@ -344,8 +344,6 @@ def __init__(self, user_config: Dict[str, Dict], glpk_model: Union[str, TextIO]) """ glpk_model: Union[str, TextIO] Path to GLPK model file. Can be created using the `--wglp` flag. - If not provided, the solution file will be processed without - corresponding english names or index defenitions. """ super().__init__(user_config) @@ -362,7 +360,7 @@ def _convert_to_dataframe(self, glpk_sol: Union[str, TextIO]) -> pd.DataFrame: Arguments --------- - glpk_sol: str + glpk_sol: Union[str, TextIO] Path to GLPK solution file. Can be created using the `--write` flag Returns @@ -385,7 +383,7 @@ def read_model(self, file_path: Union[str, TextIO]) -> pd.DataFrame: Arguments --------- - file_path: str + file_path: Union[str, TextIO] Path to GLPK model file. Can be created using the `--wglp` flag. Returns @@ -434,7 +432,7 @@ def read_solution( Arguments --------- - file_path: str + file_path: Union[str, TextIO] Path to GLPK solution file. Can be created using the `--write` flag Returns