Skip to content

Commit add720b

Browse files
committed
docs(py): sync docstrings with code in tools.restart2solution and run.projection
- tools.py: update restart2solution docstring to match signature (state=None), per review. - projection.py: clarify that the 'state' parameter is accepted for API compatibility and currently unused. - No functional changes. Signed-off-by: shbhmexe <[email protected]>
1 parent 07fc53e commit add720b

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

SU2_PY/SU2/io/tools.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1173,7 +1173,7 @@ def make_link(src, dst):
11731173

11741174

11751175
def restart2solution(config, state=None):
1176-
"""restart2solution(config,state={})
1176+
"""restart2solution(config, state=None)
11771177
moves restart file to solution file,
11781178
optionally updates state
11791179
direct or adjoint is read from config

SU2_PY/SU2/run/projection.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def projection(config, state=None, step=1e-3):
5454
5555
Inputs:
5656
config - an SU2 config
57-
state - only required when using external custom DV
57+
state - accepted for API compatibility; currently unused by this function
5858
step - a float or list of floats for geometry sensitivity
5959
finite difference step
6060

0 commit comments

Comments
 (0)