Move getFormattedStacksForAllThreads from watchdog to logHandler, to fix build of developer documentation.#15616
Merged
seanbudd merged 2 commits intoOct 12, 2023
Conversation
…fix build of developer documentation.
5 tasks
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
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.
Link to issue number:
None, related to #12971 problem caused by PR #14899
Summary of the issue:
When trying to build developer documentation with Sphinx, many modules failed to be parsed with one of the following errors:
I've tracked this down to PR #14899, which imported stuff from
watchdogin thehwIopackage.Description of user facing changes
None - this only moves code used internally for logging.
Description of development approach
getFormattedStacksForAllThreadsis moved fromwatchdogto thelogHandler, which avoids these warnings. Appropriate backwards compatibility is added towatchdog, to make sure add-on authors are warned to use the moved function fromlogHandlerin the future.Testing strategy:
Ensured that for affected modules developer documentation can once again be created.
Known issues with pull request:
getFormattedStacksForAllThreadsshould be placed I'd be happy to hear themCode Review Checklist: