Skip to content

Commit

Permalink
update ReadGlpk docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
trevorb1 committed Aug 15, 2023
1 parent c1f8865 commit 0756c9d
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/otoole/results/results.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 0756c9d

Please sign in to comment.