Skip to content

Commit 3a5d54f

Browse files
CopilotAlxiice
authored andcommitted
Fix documentation in save_callback.py to match implementation
1 parent b157ce9 commit 3a5d54f

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

meshroom/core/save_callback.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
44
When the environment variable MR_ASK_TEMPLATE_BEFORE_SAVING is set to "1",
55
this module registers a "save" callback that returns information about whether
6-
the user wants to save as a template or do a standard save.
6+
the user should be asked to choose between saving as a template or a standard save.
77
88
The callback returns a dictionary:
9-
{"saveAsTemplate": True/False}
9+
{"askTemplate": True}
1010
11-
This result is used by the QML save dialog to decide which save logic to execute.
11+
This result is used by the QML save dialog to decide whether to present
12+
a choice dialog to the user.
1213
"""
1314

1415
import os
@@ -25,7 +26,7 @@ def _saveCallback(*args, **kwargs):
2526
as a template or as a standard project file.
2627
2728
Returns:
28-
dict: {"saveAsTemplate": True} to indicate the system should present
29+
dict: {"askTemplate": True} to indicate the system should present
2930
the template-or-save choice to the user.
3031
"""
3132
return {"askTemplate": True}

0 commit comments

Comments
 (0)