Community
Participate
Working Groups
Extracted from http://dev.eclipse.org/mhonarc/lists/cross-project-issues-dev/msg11792.html I'd like to propose one enhancement to the error reporting tool: avoid abbreviating exceptions. I have come across different bugs that said "RE in SomeClass.someMethod" but the RE term was not consistent. It was either RuntimeException or ResourceException. Abbreviations like NPE are well-known and don't complicate the thing, but abbreviations like SISPSIE, NCDFE, LLTE, BPCE, SDRME and a few others are not obvious (well, at least for me). Would it be possible to use the full name of the exception instead of its abbreviation?
I would also rather like to see the full exception names, the abbreviations are really cryptic (except of course for the short and well known ones like NPE). Michael
+1 for using the exception name for clarity (not the fully qualified name).
There are relatively exception names that we all know well. I suggest that only NPE, CCE, IOE, ISE, UOE, AIOOBE (and perhaps a few others that I have overlooked) are abbreviated.
+1 for not using abbreviations
-1: compactness is good, and we will learn the abbreviations in short order. Could you use a hover to show the full name on click / tap? Or link to a page with the abbreviations? @Ed: I have no idea what ISE or UOE are. I can find out, but I think we'd find the pool of common abbreviations is surprisingly small.
(In reply to Brian de Alwis from comment #5) > -1: compactness is good Right, but only as long as it does not impact the understandability of the information the bug title is trying to convey. > and we will learn the abbreviations in short order. Abbreviations are not unique so it's not possible to know what a given abbreviation stands for. Therefore, it makes no sense to start learning what RE stands for as you never know whether a given RE would be RuntimeException or ResourceException.
(In reply to Szymon Ptaszkiewicz from comment #6) > Abbreviations are not unique The small number of abbreviations would be unique so I suggest that if RE is permitted at all it should be RuntimeException. (In reply to Brian de Alwis from comment #5) > @Ed: I have no idea what ISE or UOE are. I can find out, but I think we'd > find the pool of common abbreviations is surprisingly small. While I'm not sure who you are, I'm sure I've seen your name a few times, so if you don't know ISE and UOE, I retract my suggestion for just a few cherry-picked abbreviations. +1 for no abbreviations.
Thank you all. It looks like most people currently prefer non-abbreviated names. I'll rewrite the problem summaries until the weekend and let you know when it's done. After that, we can discuss the other direction whether long names take too much space. But this discussion should be postponed until we see it live :-)
The change is live. https://dev.eclipse.org/recommenders/committers/confess/#/problems/?page=0&size=10&sort=modifiedOn,desc Please let me know if you dislike it.
(In reply to Marcel Bruch from comment #9) > The change is live. > > https://dev.eclipse.org/recommenders/committers/confess/#/problems/ > ?page=0&size=10&sort=modifiedOn,desc > > Please let me know if you dislike it. Nice! I prefer this variant with simple class names over the camel-case abbreviated names.
(In reply to Marcel Bruch from comment #9) > The change is live. > > https://dev.eclipse.org/recommenders/committers/confess/#/problems/ > ?page=0&size=10&sort=modifiedOn,desc > > Please let me know if you dislike it. Looks great! Thank you, Marcel.
Consider fixed. Continue / reopen the discussion if someone has strong opinions about the current solution.
