Changeset 120

Show
Ignore:
Timestamp:
08/02/06 05:45:24 (2 years ago)
Author:
mk
Message:

Added footnotes describing docstring indices in detail.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/mk/README

    r117 r120  
    187187 
    188188    * README: 30 
    189     * LICENCE/COPYING: 30 
    190     * ANNOUNCE/CHANGELOG: 20 
     189    * LICENCE/COPYING: 30 [#oneof]_ 
     190    * ANNOUNCE/CHANGELOG: 20 [#oneof]_ 
    191191    * INSTALL: 20 
    192192    * AUTHORS: 10 
    …… 
    198198  * package contain directories listed below 
    199199 
    200     * doc/docs: 30 
    201     * test/tests: 30 
    202     * demo/example/examples: 10 
    203  
    204   * code is documented by docstrings: 100 
    205   * docstrings have proper formatting (like epytext or reST): 30 
     200    * doc/docs: 30 [#oneof]_ 
     201    * test/tests: 30 [#oneof]_ 
     202    * demo/example/examples: 10 [#oneof]_ 
     203 
     204  * code is documented by docstrings: 100 [#docstrings]_ 
     205  * docstrings have proper formatting (like epytext or reST): 30 [#formatted]_ 
    206206 
    207207* Code Kwalitee 
    …… 
    213213listed above. Score is presented in absolute range (number of points) 
    214214and relative (percent of gathered points compared to maximum). 
     215 
     216.. [#oneof] It is enough for a package to contain only one of listed files. 
     217.. [#docstrings] Number of points is proportional to percent of documentable objects 
     218   (module, class or function) that have docstrings. For example, if 
     219   you have 50 documentable objects and 32 of them have docstrings 
     220   your code will get 64 points ('cause 64% of objects are documented). 
     221.. [#formatted] Number of points depends on number of docstrings that are found 
     222   to contain one of known markup. Currently ReST, epytext and javadoc are 
     223   recognized. We give 10 points for 25% of formatted docstrings, 20 points 
     224   for 50% and 30 points for 75%. 
    215225 
    216226Sample output 
    …… 
    257267by the Cheesecake metrics. 
    258268 
    259 .. footer:: Last modified 2006-07-30 by `Michal Kwiatkowski <http://joker.linuxstuff.pl>`_. 
     269.. footer:: Last modified 2006-08-02 by `Michal Kwiatkowski <http://joker.linuxstuff.pl>`_.