FLUID-2065: Tech review of Simple Text Inline Edit API docs

Metadata

Source
FLUID-2065
Type
Task
Priority
Critical
Status
Closed
Resolution
Fixed
Assignee
Anastasia Cheetham
Reporter
Anastasia Cheetham
Created
2009-01-06T15:28:21.000-0500
Updated
2009-06-03T13:41:56.000-0400
Versions
N/A
Fixed Versions
  1. 0.8
Component
  1. Inline Edit
  2. Tech. Documentation

Description

A technical review of
http://wiki.fluidproject.org/display/fluid/Simple+Text+Inline+Edit+API

  • Check page for correctness against current code base:
    o function signatures
    o options (selectors, supported events, styles, etc.)
    o dependencies
    o etc.
  • Check links between pages, add and update where appropriate.

Bug Parade 0.8 release

Comments

  • Eli Cochran commented 2009-02-08T17:29:29.000-0500

    I've reviewed the Simple Inline Edit API docs, and made some minor revisions where necessary.

    There are three things missing from the current docs, they may have been added after 0.7, or it maybe that they are things which we don't want to document because they are of limited utility to the integrator, although I note them because they seem to have some utility:

    Under Supported Events, we don't mention the afterInitEdit event.

    Under Functions, we don't mention that.isEditing() or that.cancel()

  • Anastasia Cheetham commented 2009-02-11T10:55:29.000-0500

    I've documented afterInitEdit and that.cancel(), waiting for input from Antranig on that.isEditing().

  • Anastasia Cheetham commented 2009-02-11T11:29:28.000-0500

    All of Eli's comments have now been addressed.