Changes between Version 8 and Version 9 of Orange25/DevelopmentGuidelines


Ignore:
Timestamp:
02/04/12 13:14:44 (3 years ago)
Author:
marko
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Orange25/DevelopmentGuidelines

    v8 v9  
    11== Documentation == 
     2 
     3=== Overview === 
     4 
     5Avoid conversational style that was common in previous documentation (for example, rewrite sentences containing "you"). Avoid future tense; use present instead (for example, "classifier will be used" -> classifier is used"). 
     6 
     7Examples of documentation that is OK: 
     8 
     9* http://orange.biolab.si/doc/reference/Orange.data.variable/ 
     10* http://orange.biolab.si/doc/reference/Orange.feature.scoring/ 
     11* http://orange.biolab.si/doc/reference/Orange.classification.knn/ 
    212 
    313=== Code samples === 
     
    1121See :download:`this example script <../example.py>`. 
    1222}}} 
     23 
     24=== Referencing other classes, functions, methods === 
     25 
     26If it is clear what are writing about, use shorter form, for example, :obj:`~Orange.classification.rules.X` instead of :obj:`Orange.classification.rules.X`.  
    1327 
    1428== Coding ==