Skip to content

gh-108198: Add Logger._log and Logger.manager documentation#114248

Closed
toxinu wants to merge 3 commits into
python:mainfrom
toxinu:add-logger-documentation
Closed

gh-108198: Add Logger._log and Logger.manager documentation#114248
toxinu wants to merge 3 commits into
python:mainfrom
toxinu:add-logger-documentation

Conversation

@toxinu

@toxinu toxinu commented Jan 18, 2024

Copy link
Copy Markdown

I just added some brief documentation for the Logger._log method and Logger.manager attribute.
I am unsure if we want the Logger.manager attribute documented since the whole logging.Manager class isn't documented.

This is my very first PR against cpython so 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/

@toxinu toxinu requested a review from vsajip as a code owner January 18, 2024 13:14
@ghost

ghost commented Jan 18, 2024

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@toxinu toxinu force-pushed the add-logger-documentation branch from c29e430 to d92dba9 Compare January 18, 2024 13:18
@AA-Turner AA-Turner self-requested a review January 18, 2024 15:16
@AA-Turner AA-Turner added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jan 18, 2024

@vsajip vsajip left a comment

Copy link
Copy Markdown
Member

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!

@AA-Turner

Copy link
Copy Markdown
Member

@vsajip have you seen the linked #108198? Ought that be closed too?

A

@vsajip

vsajip commented Jan 18, 2024

Copy link
Copy Markdown
Member

Ought that be closed too?

Yes, I suppose so.

@toxinu

toxinu commented Jan 19, 2024

Copy link
Copy Markdown
Author

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!

Thanks a lot for your explanation. That makes total sense to me. Let's close this PR and the related issue then. 👍

@toxinu toxinu closed this Jan 19, 2024
@erlend-aasland

Copy link
Copy Markdown
Contributor

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!

@vsajip, is there a list of public but deliberately undocumented logging attributes anywhere?

@vsajip

vsajip commented Jan 30, 2024

Copy link
Copy Markdown
Member

No, the reason they're not publicly listed is that they are considered internal.

@erlend-aasland

Copy link
Copy Markdown
Contributor

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.

@vsajip

vsajip commented Jan 30, 2024

Copy link
Copy Markdown
Member

OK, it seems reasonable to add comments in the source.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants