API changes in 1.3: Inline Edit
acheetham at ocad.ca
Thu Nov 4 13:46:49 UTC 2010
On 2010-11-04, at 6:41 AM, Colin Clark wrote:
>> Functions moved to public namespace
>> Many functions were moved into the public "fluid.inlineEdit.*" namespace that weren't there before. These are *not* public functions on the component's 'that.' I think they're probably in the class of "things that aren't actually meant for public use." They include event binding functions, view accessor setup functions, etc.
> Can you enumerate the various functions you've moved into the public namespace, and elaborate on why you think they're "things that aren't actually meant for public use?" I'd encourage us to either stretch our assumptions about what might be fit for public usage, or--if these functions really aren't suitable for anyone to use--remove them from public view. The former is, of course, preferred.
Colin, my comments come in part from a discussion we had in the dev meeting yesterday: Antranig pointed out that the framework now contains several functions that are technically in the public namespace, but that we don't actually expect Infusion users to ever use, and which in his opinion shouldn't have user-facing documentation. We discussed how we might make a note of this in the code so that documentation-writers know not to include these functions when writing.
I believe Antranig is planning to post something to the list about the discussion we had.
As for the functions in Inline Edit, Justin and I talked about them this morning. Many of the functions are apparently things that users might not want to override directly, but might wish to make use of if they do override either of the renderers (editModeRenderer or displayModeRenderer). In this case, they should be public, and documented.
I believe Justin is planning to post a summary of what the functions are, to help us identify whether or not any of them shouldn't actually be public.
Anastasia Cheetham Inclusive Design Research Centre
acheetham at ocad.ca Inclusive Design Institute
More information about the fluid-work