The "Fossies" Software Archive
... Fresh Open Source Software mainly for Internet, Engineering and Science ...

Fossies spelling error score points calculation and grade assignment

First of all: The Fossies source code spelling error grade assignment is more a gimmick instead of a serious rating tool. As only a very rough indicator it's not well suited to compare different projects but it may be a motivating reference point within the possibly troublesome spelling correction process.

Fossies spelling error score points calculation

The basic idea for the scoring is to set the number of spelling errors in relation to the coded words (to get reasonable integers that value is multiplied by an arbitrary scale factor of 100000). Every found error type counts fully but any further occurrence of such an error only half. Since the effort for counting the number of words is too big we use simply the number of lines reported by the Fossies CLOC ("Count Lines Of Code") analysis. But we are weighting the number of comment lines twice compared to the real code lines since they may contain more potential to make spelling errors.

So Fossies uses internally the following a little bit arbitrary and probably often "unfair" formula to calculate the spelling error score points:

                      NO_OF_SPELL_ERROR_TYPES + (NO_OF_SPELL_ERROR_OCCURRENCES - NO_OF_SPELL_ERROR_TYPES) / 2
     SCORE = 100000 * ---------------------------------------------------------------------------------------
                                            2 * NO_OF_COMMENT_LINES + NO_OF_CODE_LINES                        

The calculated score points are principally visible as tooltip if the mouse is moved about a shown grade (see the example line below).

Fossies grade assignment

The - logarithmic - grade assignment may appear a little bit "strict" but it's easy to become a better grade by simply typing some correcting letters ;-)

SCOREGRADESCOREGRADESCOREGRADESCOREGRADESCOREGRADESCOREGRADE
≤ 1A+≤ 10B+≤ 26C+≤ 65D+≤ 165E+> 320F
≤ 4A ≤ 14B ≤ 37C ≤ 95D ≤ 240E
≤ 7A-≤ 19B-≤ 50C-≤125D-≤ 320E-

The in this way assigned grade is shown in a line like the example line below that can be found near the top of a Fossies codespelling analysis page:

   Source code spelling error rating grade: "C+"

Since surprisingly there appears to be a need for corresponding status icons (e.g. usable in README.md files), such Fossies Codespell Report Badges are now also offered.


Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  Codespell  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)