Closed Skelmis closed 2 months ago
Class ThreadWithMessage is not publically documented which may lead to some confusion for users trying to debug error messages using the class
ThreadWithMessage
ThreadWithMessage was exported in PR 879 however it does not appear to have been added to the documentation.
As seen here the class does find use, but given it's lack of public docs it requires source code diving to understand how to use it.
For example when the class is returned, the documentation simply show it as the following non-named tuple:
This may lead to confusion as users could struggle to debug it themselves since it isn't in the docs for public API things
No response
This class is exported in the documentation
It is not
NA
Summary
Class
ThreadWithMessage
is not publically documented which may lead to some confusion for users trying to debug error messages using the classReproduction Steps
ThreadWithMessage was exported in PR 879 however it does not appear to have been added to the documentation.
As seen here the class does find use, but given it's lack of public docs it requires source code diving to understand how to use it.
For example when the class is returned, the documentation simply show it as the following non-named tuple:
This may lead to confusion as users could struggle to debug it themselves since it isn't in the docs for public API things
Minimal Reproducible Code
No response
Expected Results
This class is exported in the documentation
Actual Results
It is not
Intents
NA
System Information
Checklist
Additional Context
No response