Enhance SF labnotebook reporting #2432
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
timjarsky
previously approved these changes
May 29, 2025
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
from
e938639 to
a234be5
Compare
This comment was marked as outdated.
This comment was marked as outdated.
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
2 times, most recently
from
2b38d00 to
c9a4c53
Compare
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
from
c9a4c53 to
e15a7a9
Compare
This comment was marked as outdated.
This comment was marked as outdated.
timjarsky
previously approved these changes
Aug 4, 2025
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
from
e15a7a9 to
11b3f8c
Compare
4 tasks
Collaborator
Author
|
Fixed conflicts. |
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
from
11b3f8c to
a5ec44d
Compare
Collaborator
Author
|
Will merge onced CI finished. |
This is a constant counting the number of different modes. So it does not make sense to accept it for the labnotebook sweepFormula operation.
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
from
a5ec44d to
802cba3
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the SF labnotebook reporting by improving error handling and user feedback when labnotebook keys cannot be found. It implements fallback behavior and warning messages to guide users when incorrect modes are used.
Key changes:
- Adds warning messages when labnotebook keys cannot be found with the specified mode but are available with a fallback mode
- Implements proper error reporting for missing labnotebook keys and invalid wildcards
- Removes deprecated mode option and adds mode stringification utility
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Packages/MIES/MIES_SweepFormula_Operations.ipf | Core logic for enhanced labnotebook error handling and fallback behavior |
| Packages/MIES/MIES_MiesUtilities_Logbook.ipf | Utility function for mode stringification and removes deprecated mode option |
| Packages/tests/Basic/UTF_SweepFormula_Operations.ipf | Comprehensive test coverage for new warning messages and fallback scenarios |
| Packages/tests/UTF_HelperFunctions.ipf | Test data setup with independent labnotebook entries |
| Packages/doc/SweepFormula.rst | Documentation update explaining fallback behavior |
| Packages/tests/Basic/UTF_Macros.ipf | Removes debugging code |
A common error is to not pass UNKNOWN_MODE when asking for user labnotebook entries or entries like "User comment". In these cases we now warn and fallback automatically to UNKNOWN_MODE.
The SweepFormula labnotebook operation uses GetLastSettingChannel internally. And this falls back to independent entries automatically. Let's document that and add a test so that this stays working.
…vocation This was left from developing, in addition the controls does not exist anymore since fd05d85 (DB: Replace SF error SetVar/status LED with Notebook, separate internal error state, 2025-07-22).
t-b
force-pushed
the
bugfix/2432-labnotebook-better-error-reporting
branch
from
0371c13 to
4d15b22
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We know warn the user when the wrong mode is used.
Close #2392
Close #2394