[ python-Bugs-1720726 ] docu enhancement for logging.handlers.SysLogHandler

[SourceForge.net]

Bugs item #1720726, was opened at 2007-05-17 13:20
Message generated for change (Comment added) made by vsajip
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1720726&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Private: No
Submitted By: rhunger (rhunger)
Assigned to: Vinay Sajip (vsajip)
Summary: docu enhancement for logging.handlers.SysLogHandler

Initial Comment:
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.




----------------------------------------------------------------------

>Comment By: Vinay Sajip (vsajip)
Date: 2007-05-25 07:28

Message:
Logged In: YES 
user_id=308438
Originator: NO

Updated docstring and documentation checked into trunk, release24-maint,
release25-maint.

----------------------------------------------------------------------

Comment By: Neal Norwitz (nnorwitz)
Date: 2007-05-17 21:30

Message:
Logged In: YES 
user_id=33168
Originator: NO

Vinay, any comment?

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1720726&group_id=5470