Project

General

Profile

Actions

action #127

closed

Source code documentation

Added by ancorgs about 11 years ago. Updated about 11 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2013-03-05
Due date:
% Done:

100%

Estimated time:
1.00 h

Description

Not a separate task, in fact, just a reminder.

Actions #1

Updated by ancorgs about 11 years ago

  • % Done changed from 0 to 50
  • Status changed from New to In Progress

More than one hour wasted trying to write a Rake task for automatically documenting the models (including state machines) and helpers until I realized that state_machine documentation features were only on the git version (the were including more than a year ago, but no new gem have been officialy released).

A rake doc:html task was finally added and all models and helpers (custom simple_form inputs also) are already fully documented.

Actions #2

Updated by ancorgs about 11 years ago

  • % Done changed from 50 to 100
  • Status changed from In Progress to Closed

Not a closed issue in fact, since documentation needs constant updates, but both the infrastructure (rake task, gems) most initial documentation (readme, license, about) are already there.

Actions

Also available in: Atom PDF