Well, perhaps since this is all "sneak peek" I didn't express myself
very well. The function isn't really usable without the use of the
options that are contained inside "rendererFnOptions" so we certainly
don't seem to have the option to simply omit them from all
documentation. I guess the fact that this is "sneak peek" in the whole
gives us enough margin in the fact that this whole API will probably be
reviewed and change somewhat in an upcoming release - but perhaps it
would be worth highlighting that the options in "rendererFnOptions" are
the ones most likely to be reviewed.
On 08/12/2010 14:47, Cheetham, Anastasia wrote:
Antranig, thanks for the clarification. So to make sure I understand correctly:
On 2010-12-08, at 4:31 PM, Antranig Basman wrote:
I think everything under "rendererFnOptions" should be considered
unsupported.
So basically: Don't even mention "rendererFnOptions" in the user-facing options.
Yes, "model" is not necessary on rendererOptions since everything is
governed by the top level model,
So anything that is mentioned the top level (such as 'model') should not be
mentioned for lower levels in the user-facing docs (the internals will take
care of ensuring that the options are passed on). Options that are exclusive to
the lower level should be documented.
and similarly for elements of
"expanderOptions", this doesn't need to be configured more than once.
"expanderOptions" is a partof "rendererFnOptions" and so wouldn't even be
mentioned, right??
I guess I have *some* concerns about the stability of all of this API
since it has not really been through much review and consideration. For
example the "selectors", "repeatingSelectors" and "selectorsToIgnore"
pattern worries me a bit as well - I presume we are designating this
entire function as part of "sneak peek" in any case, since it is all new
in this release.
Yes, the entire fluid.initRendererComponent() function is branded as Sneak
Peek, so users should be suitably warned.
_______________________________________________________
fluid-work mailing list - [email protected]
To unsubscribe, change settings or access archives,
see http://fluidproject.org/mailman/listinfo/fluid-work
