code review 5642071: log/syslog: fix documentation for NewLogger

log/syslog: fix documentation for NewLogger
Fixes issue 2798.

[r, 2012-02-09 02:00:20]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[bradfitz, 2012-02-09 02:02:46]

I've never looked at this API before.  It returns nil without saying why on
error?  Gross?


On Wed, Feb 8, 2012 at 6:00 PM, <r@golang.org> wrote:

> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://go.googlecode.com/hg/
>
>
> Description:
> log/syslog: fix documentation for NewLogger
> Fixes issue 2798.
>
> Please review this at
http://codereview.appspot.com/**5642071/<http://codereview.appspot.com/5642071/>
>
> Affected files:
>  M src/pkg/log/syslog/syslog.go
>
>
> Index: src/pkg/log/syslog/syslog.go
> ==============================**==============================**=======
> --- a/src/pkg/log/syslog/syslog.go
> +++ b/src/pkg/log/syslog/syslog.go
> @@ -155,14 +155,14 @@
>        return n.conn.Close()
>  }
>
> -// NewLogger provides an object that implements the full log.Logger
> interface,
> -// but sends messages to Syslog instead; flag is passed as is to Logger;
> -// priority will be used for all messages sent using this interface.
> -// All messages are logged with priority p.
> -func NewLogger(p Priority, flag int) *log.Logger {
> +// NewLogger creates a log.Logger whose output is written to
> +// the system log service with the specified priority. The logFlag
> +// argument is the flag set passed through to log.New to create
> +// the Logger.
> +func NewLogger(p Priority, logFlag int) *log.Logger {
>        s, err := New(p, "")
>        if err != nil {
>                return nil
>        }
> -       return log.New(s, "", flag)
> +       return log.New(s, "", logFlag)
>  }
>
>
>

[r2, 2012-02-09 02:06:06]

it's new to me too. not much to like about it, but you're right, that's
horrible.

who uses this? it's an api change to fix this function. i'd rather it panicked
than returned nil.

-rob

[rsc, 2012-02-09 03:28:26]

We should clean this up.  It is not widely used.

[r, 2012-02-09 03:34:57]

Hello golang-dev@googlegroups.com, bradfitz@golang.org, r@google.com,
rsc@golang.org (cc: golang-dev@googlegroups.com),

Please take another look.

[rsc1, 2012-02-09 03:38:15]

LGTM

[r, 2012-02-09 03:41:03]

*** Submitted as http://code.google.com/p/go/source/detail?r=bc3885f94995 ***

log/syslog: fix documentation for NewLogger
Fixes issue 2798.

R=golang-dev, bradfitz, r, rsc, rsc
CC=golang-dev
http://codereview.appspot.com/5642071