Ticket #933 (closed task: fixed)

Opened 3 years ago

Last modified 3 years ago

Orange.classification.bayes: documentation

Reported by: marko Owned by: anze
Milestone: 2.5 Component: orng_modules
Severity: major Keywords:
Cc: Blocking:
Blocked By:

Description

Check the documentation to prepare it for proof-reading.

Some suggestions:

  1. Add links to arguments, parameters when possible. For example, in "Setting this attribute disables the above described attribute m..." "m" is not a link.
  2. Remove the old C++ classes from the user and put the necessary documentation (and perhaps, if not everything is supported, also necessary parameters and functions) to Orange.classification.bayes.something classes, like it was done for Classification trees.
  3. Replace "instances" in function arguments with "data".
  4. Rewrite the first paragraph. The first sentence is wrong (and could probably be deleted). What are the conditional probabilities in the second? "The algorithm learns very fast..." should probably be "The algorithm is very fast." while the details belong to BayesLearner.

Please conform to the current style and terminology. Documentation that is believed to be OK:

Change History

comment:1 Changed 3 years ago by anze

  • Status changed from new to closed
  • Resolution set to fixed

In [11897]:

(The changeset message doesn't reference this ticket)

Note: See TracTickets for help on using tickets.