-
-
Notifications
You must be signed in to change notification settings - Fork 33.4k
gh-108198: Add Logger._log and Logger.manager documentation
#114248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
5ac15c2 to
c29e430
Compare
c29e430 to
d92dba9
Compare
vsajip
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your effort, Geoffrey, but those things are deliberately left undocumented as they are internal implementation details that could conceivably change in the future. Of course they haven't actually changed for a long time, but that doesn't change the logic of my statement. Please close this PR & issue, and if you found some typos related to back-quotes, please make a separate PR for that. Thanks!
Yes, I suppose so. |
Thanks a lot for your explanation. That makes total sense to me. Let's close this PR and the related issue then. 👍 |
@vsajip, is there a list of public but deliberately undocumented |
|
No, the reason they're not publicly listed is that they are considered internal. |
Perhaps a Sphinx comment or a comment in the Python source could be helpful, to avoid unneeded efforts like this. |
|
OK, it seems reasonable to add comments in the source. |
I just added some brief documentation for the
Logger._logmethod andLogger.managerattribute.I am unsure if we want the
Logger.managerattribute documented since the wholelogging.Managerclass isn't documented.This is my very first PR against
cpythonso please give any advice or feel free to just close the PR if it is useless.I also fixed two double-back quotes on the same documentation page. Should I move that to another PR?
📚 Documentation preview 📚: https://cpython-previews--114248.org.readthedocs.build/