Description

CAM-Gerlach

opened on Oct 15, 2022

Issue body actions

Part of #95913

A createSocket() method was added to the SysLogHandler class for issue #88457 by PR #26490 to match the one in SocketHandler, but unlike the latter, the former was not documented (and also not mentioned in What's New).

@vsajip , shouldn't this be documented? If so, do you think you could help draft something describing its semantics and usage (I can help do the final writeup, but its not entirely clear to me what the precise intended behavior is, since it doesn't seem too similar internally to the other documented function, and there is no docstring). Thanks!

Activity

1. CAM-Gerlach

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   3.11only security fixesonly security fixes

   on Oct 15, 2022
2. CAM-Gerlach

   assigned

   vsajip

   and

   CAM-Gerlach

   on Oct 15, 2022
3. CAM-Gerlach commented on Oct 16, 2022

   

   CAM-Gerlach

   on Oct 16, 2022

   MemberAuthor

   More actions

   Also, I noticed logging.getLevelNamesMapping was added as well, but not mentioned in What's New. Seems like at least a brief note/reference would be worth adding, too (which I could easily do on my own as part of or separate from this, as its already documented).
4. vsajip commented on Oct 16, 2022

   

   vsajip

   on Oct 16, 2022

   Member

   More actions

   Also, I noticed logging.getLevelNamesMapping was added as welll, but not mentioned in What's New ... which I could easily do on my own as part of or separate from this

   I'd say please do it separately, as it's unrelated to the socket creation part of the issue.
5. vsajip

   added a commit that references this issue on Oct 16, 2022

   pythongh-98307: Add docstring and documentation for SysLogHandler.cre…

   0eb2f90
6. CAM-Gerlach commented on Oct 16, 2022

   

   CAM-Gerlach

   on Oct 16, 2022

   MemberAuthor

   More actions

   Thanks for the quick response!

   Sure; the main reason I didn't just do it separately to begin with was the PRs would conflict (at least as far as the What's New is concerned), but I just added the two What's New entries to the same PR, leaving your PR to document createSocket as a separate one (which makes a lot more sense anyway).

   See #98320 for that.
7. vsajip

   added 3 commits that reference this issue on Oct 16, 2022

   gh-98307: Add docstring and documentation for SysLogHandler.createSoc…

   f6b1e40

   [3.11] pythongh-98307: Add docstring and documentation for SysLogHand…

   489d3ed

   [3.11] gh-98307: Add docstring and documentation for SysLogHandler.cr… (

   f64e26c
8. vsajip

   closed this as completedon Oct 16, 2022
9. carljm

   added a commit that references this issue on Oct 17, 2022

   Merge branch 'main' into typewatch

   cdbe93b

Issue actions