Ticket #839 (closed defect: fixed)

Opened 8 years ago

Last modified 7 years ago

Some plugins names do not match their labels

Reported by: curtis Owned by: bdezonia
Priority: minor Milestone: imagej2-b4-plugins
Component: Plugins Version:
Severity: minor Keywords:
Cc: Blocked By:
Blocking: #1340

Description

When looking for a plugin's source code, users will first look for a Java source file matching the plugin's menu label, but in camel case. We should try to comply with this assumption whenever possible. Otherwise, it is more difficult to find source code of interest.

For example, the IJ2 Image Calculator is called ImageMath.java. Why not call it ImageCalculator.java instead?

Change History

comment:1 Changed 7 years ago by bdezonia

  • Blocking 1340 added

comment:2 Changed 7 years ago by bdezonia

A long time ago ImageMath was renamed to RealImageCalculator (because it deals with RealType images). It could just be Image Calculator but then if we add a separate calculator that handles ComplexType images we'll be in the same pickle. If you'd still like it to be ImageCalculator then let me know.

comment:3 Changed 7 years ago by curtis

I think whenever possible, our plugin names should be camel-cased versions of the corresponding menu labels. And of course those menu labels should match the corresponding ImageJ1 plugin when the functionality is intended as a replacement.

Regarding a complex image calculator, ideally, we would not need a separate calculator for that but would enhance the Image Calculator to handle both real and complex. But if we absolutely needed it to be a separate plugin for some reason, we could call it ComplexImageCalculator ("Complex Image Calculator" in the menus) and that would not clash with the existing implementation.

So let's rename it to ImageCalculator to match the convention.

And please feel free to rename any other plugins you notice that do not match this convention, too. (I know I have been guilty of at least a couple of such cases...)

comment:4 Changed 7 years ago by bdezonia

  • Status changed from new to closed
  • Resolution set to fixed

Situation improved with large commit a38dc0964f56b4a75ffb8770ce69479a7ca9e19e

Note: See TracTickets for help on using tickets.