Skip to content

Commit

Permalink
Correct ExtensiveForm docstring arg order and add missing parameter (
Browse files Browse the repository at this point in the history
…#465)

- Update the docstring of the `ExtensiveForm` class to match the order of
  arguments in the `__init__` method signature.
- Add the missing `all_nodenames` argument to the docstring, using a
  description consistent with the parent class `SPBase` but styled to
  match `ExtensiveForm`.

Co-authored-by: Maximilian Fey <[email protected]>
Co-authored-by: David L Woodruff <[email protected]>
  • Loading branch information
3 people authored Dec 2, 2024
1 parent df452aa commit a4d6e8d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions mpisppy/opt/ef.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,13 @@ class ExtensiveForm(mpisppy.spbase.SPBase):
scenario_creator (callable):
Scenario creator function, which takes as input a scenario
name, and returns a Pyomo model of that scenario.
scenario_creator_kwargs (dict, optional):
Keyword arguments passed to `scenario_creator`.
all_nodenames (list, optional):
List of all node names, incl. leaves. Can be None for two-stage
problem.
model_name (str, optional):
Name of the resulting EF model object.
scenario_creator_kwargs (dict):
Keyword args passed to `scenario_creator`.
suppress_warnings (bool, optional):
Boolean to suppress warnings when building the EF. Default
is False.
Expand Down

0 comments on commit a4d6e8d

Please sign in to comment.