log/syslog: variables and documentation for facility misleading #15731
Labels
Documentation
FrozenDueToAge
NeedsFix
The path to resolution is known, but the work has not been done.
Milestone
syslog.Dial
andsyslog.New
take asyslog.Priority
as an argument and stores it in a field namedpriority
. This field is used exactly twice:writeAndRetry
Writer.Write
For examples of someone confused by this in the wild, check out
logrus_syslog
orgolang-samples
, which thinks that creating a syslog writer with a severity instead of a facility will do something meaningful:It would be great if facility was a different type from priority, but barring that it would be wonderful to update the documentation here. In particular, I would love to see
syslog.New
andsyslog.Dial
take a variable named facility and explain the difference, with an example usage.I'm happy to do it if such a change could be merged. I see that the package is "frozen" -- will it still accept doc fixes?
The text was updated successfully, but these errors were encountered: