Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#237 Typos in eclipse plugin

Unstable_(example)
closed
Oliver Burn
None
1
2013-06-12
2013-03-31
Bewied
No

The descriptions about each check often contain many typos.
One way to access these descriptions:
Project > Preferences > Checkstyle > Configure

Most prominently is "Coding Problems > Junit Test Case"
(which in itself is a typo: JUnit, not Junit).

This is the current description of the newest version available from the update site, typos markes with [sic]:

Ensures that the setUp(), tearDown() methods are named correctly, have no arguments, return void and are either public or protected.
Also ensures that suite() is named correctly, have[sic] no arguments, return[sic] junit.framewotk[sic].Test, [sic]public and static.
Rationale: often times[sic] developers will misname one or more of these methods and not realise that the method is not being called.

Suggested version (for this example:

Ensures that the setUp(), tearDown() methods are named correctly, have no arguments, return void and are either public or protected.
Also ensures that suite() is named correctly, has no arguments, returns junit.framework.Test, and is public and static.
Rationale: Developers will often misname one or more of these methods and not realise that the method is not being called.

I'll try to create a patch (diff file or similar - what do you prefer?) for all the typos I can find.

Discussion

  • Bewied
    Bewied
    2013-03-31

    Corrected the javadoc in the .java files and the user-visible strings in the
    config_*.xml files. These strings are visible to the user using the Eclipse
    plugin, so should be easily readable without typos in the way.

    I forked the project, the commit is visible at
    https://sourceforge.net/u/bewied/checkstyle/ci/2e8beea8be44f35f134c8b416ef744864ff9b506/

    I added a (locally generated) diff as attachment to make it easier.

     
    Attachments
  • Oliver Burn
    Oliver Burn
    2013-06-12

    Thanks - I applied the fixes from your fork of the project (a first for me:-)

     
  • Oliver Burn
    Oliver Burn
    2013-06-12

    • status: open --> closed
    • assigned_to: Oliver Burn