Skip to content

Commit

Permalink
corrected docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Joao-Dionisio committed Nov 27, 2024
1 parent 8cb0f1c commit b8a9cd6
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions src/pyscipopt/scip.pxi
Original file line number Diff line number Diff line change
Expand Up @@ -2890,12 +2890,23 @@ cdef class Model:
self.setIntParam("propagating/maxrounds", 0)

def writeProblem(self, filename='model.cip', trans=False, genericnames=False, verbose=True):
"""Write current model/problem to a file.
"""
Write current model/problem to a file.
Parameters
----------
filename : str, optional
the name of the file to be used (Default value = 'model.cip').
Should have an extension corresponding to one of the readable file formats,
described in https://www.scipopt.org/doc/html/group__FILEREADERS.php.
trans : bool, optional
indicates whether the transformed problem is written to file (Default value = False)
genericnames : bool, optional
indicates whether the problem should be written with generic variable
and constraint names (Default value = False)
verbose : bool, optional
indicates whether a success message should be printed
:param filename: the name of the file to be used (Default value = 'model.cip'). Should have an extension corresponding to one of the readable file formats, described in https://www.scipopt.org/doc/html/group__FILEREADERS.php.
:param trans: indicates whether the transformed problem is written to file (Default value = False)
:param genericnames: indicates whether the problem should be written with generic variable and constraint names (Default value = False)
:param verbose: whether to print a success message
"""
user_locale = locale.getlocale(category=locale.LC_NUMERIC)
locale.setlocale(locale.LC_NUMERIC, "C")
Expand Down

0 comments on commit b8a9cd6

Please sign in to comment.