[slf4j-user] Last parameter being exception is not mentioned in javadoc

[David Karr]

On Tue, Nov 13, 2018 at 11:14 AM Joachim Durchholz <jo at durchholz.org> wrote:

> Am 13.11.18 um 19:43 schrieb Joachim Durchholz:
> > Google isn't reachable for me right now so I can't easily validate, but
> > I recall that I saw it in some docs. You might have luck looking it up
> > in the Javadoc.
>
> That's what I get for spending not enough attention reading the message
> I'm answering to - it did refer to the Javadoc.
>
> The Throwable behaviour is documented in several places in the FAQ at
> https://www.slf4j.org/faq.html#paramException.
> The *package* Javadoc actually links there.
>

Yes, I later noticed this is mentioned in the FAQ.  I think it would be a
good idea for the javadoc for these methods to mention this behavior.  I
believe that most developers will assume the javadoc is telling them the
whole truth about the expected behavior of the method.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.qos.ch/pipermail/slf4j-user/attachments/20181113/49ec278e/attachment.html>