Add bool return to _base_logger, log* functions #2335
Conversation
This file contains 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
Add a bool return to expose whether log succeeded for: - _base_logger - log* functions (log*, log*_throttle, log*_once, etc...) Provides the user a trigger for actions which may be sensitive to logging (i.e. creating a 'static' positioned diagnostic display)
peci1
approved these changes
Sep 5, 2024
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.
Add a bool return to expose whether log succeeded for:
Explanation
Provides the user a trigger for actions which may be sensitive to logging (i.e. creating a 'static' diagnostic display). The return will be true, if:
In both these cases, true represents a change to console, false represents no change.
Specific example use case:
When working with the log*_throttle functions, I needed a way to detect whether a loginfo_throttle was actually printing, as I needed to know how many lines to escape and clear before writing new content on-top for a 'static' diagnostic display. The bool already existed, but just needed to be exposed to the user.