This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: docu enhancement for logging.handlers.SysLogHandler
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: vinay.sajip Nosy List: nnorwitz, rhunger, vinay.sajip
Priority: normal Keywords:

Created on 2007-05-17 13:20 by rhunger, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (3)
msg32031 - (view) Author: rhunger (rhunger) Date: 2007-05-17 13:20
The documentation for "logging.handlers.SysLogHandler" is somewhat incomplete. This class can be used to communicate to a local syslogd too (not only to log to a remote syslogd, or a local syslogd with enabled remote logging capabilities ("-r" option)).

The documentation on:

http://docs.python.org/lib/node417.html

for SysLogHandler([address[, facility]]) should be expanded with something like the following:

"""
If address is specified as a string, a UNIX socket is used. To log to a local syslogd "SysLogHandler(address="/dev/log")" can be used.
"""

The docstring "import logging.handlers;help(logging.handlers.SysLogHandler.__init__)" is rather short and could be replaced with above documentation.


msg32032 - (view) Author: Neal Norwitz (nnorwitz) * (Python committer) Date: 2007-05-17 21:30
Vinay, any comment?
msg32033 - (view) Author: Vinay Sajip (vinay.sajip) * (Python committer) Date: 2007-05-25 07:28
Updated docstring and documentation checked into trunk, release24-maint, release25-maint.
History
Date User Action Args
2022-04-11 14:56:24adminsetgithub: 44964
2007-05-17 13:20:44rhungercreate