+1 to removing email addresses from exception messages. We should do a pass
over all of Commons.

Gary

On Sun, May 12, 2019, 06:46 sebb <seb...@gmail.com> wrote:

> Some of our code has Exception messages such as the following:
>
> >> (Collections:LRUMap)
> throw new IllegalStateException("Entry.before is null." +
> " Please check that your keys are immutable, and that you have used
> synchronization properly." +
> " If so, then please report this to dev@commons.apache.org as a bug.");
> <<
>
> I guess it seemed like a good idea at the time, but I think the idea
> has backfired:
>
>
> https://lists.apache.org/thread.html/3363e23218b4c1c21b8093321ac293d68d2e4ab35b982adb53b1d5d6@%3Cdev.commons.apache.org%3E
>
> I have seen about 30 of these mails altogether so far.
>
> The intention was for the developer to capture the exception, check
> for the possible programming errors and then inform Commons developers
> if they believe there is a bug.
>
> However it looks like the developers in the case have shown the error
> message direct to end users.
>
> I think the messages (there are quite a lot in Collections, possibly
> elsewhere) should not include an email address. Instead maybe say
> something like:
>
> >>
> throw new IllegalStateException("Entry.before is null." +
> " This should not occur if your keys are immutable, and you have used
> synchronization properly." +
> >>
>
> This would leave it up to the developers to work out how contact us
> once they have eliminated any programming errors. Whilst this is a bit
> more work for the developers, I don't think it's unreasonable to
> expect developers to know how to report bugs in code they are using.
>
> WDYT?
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
>

Reply via email to