Ticket #940 (closed task: fixed)

Opened 3 years ago

Last modified 3 years ago

Orange.classification.logreg: documentation

Reported by: marko Owned by: matija
Milestone: 2.5 Component: other
Severity: minor Keywords:
Cc: Blocking:
Blocked By:

Description (last modified by marko) (diff)

Check the documentation to prepare it for proof-reading (after dealing with #732).

Please conform to the current style and terminology. Avoid 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"). Rewrite courageously!

Documentation that is believed to be OK:

 http://orange.biolab.si/doc/orange25/orange.data.feature.html  http://orange.biolab.si/doc/orange25/Orange.feature.scoring.html  http://orange.biolab.si/doc/orange25/Orange.classification.knn.html

Some suggestions:

  • Start the documentation with an easy example on the top (with and without parameter tuning).
  • Example -> instance, attribute -> feature, meta attribute -> meta attribute, etc.

Change History

comment:1 Changed 3 years ago by marko

  • Description modified (diff)

comment:2 Changed 3 years ago by matija

  • Owner set to matija
  • Status changed from new to assigned

comment:3 Changed 3 years ago by matija

  • Status changed from assigned to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.