Changeset 142

Show
Ignore:
Timestamp:
08/11/06 10:57:47 (2 years ago)
Author:
grig
Message:

Minor modifications.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/mk/README

    r140 r142  
    1616 * existence of certain files such as README, INSTALL, LICENSE, setup.py etc. 
    1717 * percentage of modules/functions/classes/methods with docstrings 
     18 * pylint score 
    1819 * ... and many others 
    1920 
    …… 
    7273for twill-0.7.4.tar.gz is /tmp/twill-0.7.4.tar.gz.log). 
    7374The log file is automatically deleted after the Cheesecake index is 
    74 computed, except for situations when error has occured. 
     75computed, except for situations when errors have occured. 
    7576 
    7677Command-line examples: 
    …… 
    99100  part of the code kwalitee index computation  
    100101* `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ is 
    101   required for testing installation 
     102  required for the installability index computation 
    102103 
    103104Obtaining the source code 
    …… 
    145146We use `nose <http://somethingaboutorange.com/mrl/projects/nose/>`_ for automatic 
    146147testing of our project, so if you want to test Cheesecake on your machine, please 
    147 install that first. Running standard set of Cheesecake unit test is as easy as:: 
     148install that first. Running the standard set of Cheesecake unit test is as easy as:: 
    148149 
    149150  python setup.py test 
    150151 
    151 This command is equivalent of:: 
     152This command is equivalent to:: 
    152153 
    153154  nosetests --verbose --with-doctest --doctest-tests --include unit --exe 
    …… 
    158159 
    159160Functional tests can take a bit longer to complete, as they test cheesecake_index 
    160 script as a whole (opposed to testing modules and classes separately). 
    161  
    162 If you happen to found any of our tests failing, please don't hesitate to contact 
     161script as a whole (as opposed to testing modules and classes separately). 
     162 
     163If you happen to find any of our tests failing, please don't hesitate to contact 
    163164us, either via 
    164 `cheesecake-devel mailing list <http://lists.sourceforge.net/lists/listinfo/cheesecake-devel>`_ 
     165`cheesecake-devel mailing list <http://lists2.idyll.org/listinfo/cheesecake-dev>`_ 
    165166or via `Cheesecake Trac <http://pycheesecake.org/>`_. 
    166167 
    …… 
    171172`here <http://agilistas.org:8888/>`_. 
    172173 
    173 Mailing list 
    174 ------------ 
    175  
    176 Developer mailing list: http://lists.sourceforge.net/lists/listinfo/cheesecake-devel 
     174Mailing lists 
     175------------- 
     176 
     177Developer mailing list: http://lists2.idyll.org/listinfo/cheesecake-dev 
     178User mailing list: http://lists2.idyll.org/listinfo/cheesecake-users 
    177179 
    178180License 
    …… 
    205207-------------------------------------------- 
    206208 
    207 Overall Cheesecke score is a sum of values of 3 main indexes 
    208 (installability, documentation and code kwalitee). Values of these 
    209 indexes rely on values of their subindexes and so on. Whole index tree 
    210 and corresponding values for each leaf is presented below: 
     209The overall Cheesecake score is the sum of values of 3 main indexes 
     210(installability, documentation and code kwalitee). The values of these 
     211indexes rely on values of their subindexes and so on. The whole index tree 
     212and corresponding values for each leaf are presented below: 
    211213 
    212214* Installability 
    …… 
    248250  * package has unit tests: 30 
    249251 
    250 Final score depends on how well package scores for all indexes 
    251 listed above. Score is presented in absolute range (number of points) 
    252 and relative (percent of gathered points compared to maximum). 
     252The final score depends on how well the package scores for all indexes 
     253listed above. The score is presented in absolute range (number of points) 
     254and relative (percent of points obtained compared to maximum possible points). 
    253255 
    254256.. [#oneof] It is enough for a package to contain only one of listed files. 
    …… 
    256258   (module, class or function) that have docstrings. For example, if 
    257259   you have 50 documentable objects and 32 of them have docstrings 
    258    your code will get 64 points ('cause 64% of objects are documented). 
     260   your code will get 64 points (because 64% of objects are documented). 
    259261.. [#formatted] Number of points depends on number of docstrings that are found 
    260262   to contain one of known markup. Currently ReST, epytext and javadoc are