3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-06-26 01:15:28 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve documentation string

Browse source 
onCurrentCallbackFinished documentation string:
- Improve clarity
- Fix grammar
- Improve layout and shorten line length
This commit is contained in:
digitalfrost 2022-08-20 19:40:58 +02:00
parent d9fb352ee2
commit 50d81225da
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
cura/TaskManagement/OnExitCallbackManager.py
View file

@ -60,10 +60,11 @@ class OnExitCallbackManager:
# Tell the application to exit
self._application.callLater(self._application.closeApplication)
# This is the callback function which an on-exit callback should call when it finishes, it should provide the
# "should_proceed" flag indicating whether this check has "passed", or in other words, whether quitting the
# application should be blocked. If the last on-exit callback doesn't block the quitting, it will call the next
# registered on-exit callback if available.
# Callback function which an on-exit callback calls when it finishes.
# It provides a "should_proceed" flag indicating whether the check has "passed",
# or whether quitting the application should be blocked.
# If the last on-exit callback doesn't block quitting, it will call the next
# registered on-exit callback if one is available.
def onCurrentCallbackFinished(self, should_proceed: bool = True) -> None:
if not should_proceed:
Logger.log("d", "on-app-exit callback finished and we should not proceed.")