Commenting "unsupported" functions (as well as supported functions)

Cheetham, Anastasia acheetham at ocad.ca
Mon Dec 13 15:32:47 UTC 2010


One of the remaining tasks before release is to identify any "public" functions/methods/instance variables/options that we don't actually want users to use, and comment to that effect in the code:
    http://issues.fluidproject.org/browse/FLUID-3881

I have some sense of different areas of the code in which these comments are needed, and I'll be pinging people about it once I've had a quick look over the code. Likely suspects:

  Antranig: framework changes
  Mike: Inline Edit (this isn't actually for 'unsupported' things, but descriptions of newly public functions that are supported)
  Justin: Progress
  Colin/Mike: Uploader
  Harris: Reorderer

There may be more, I'll know once I check the code.

-- 
Anastasia Cheetham     Inclusive Design Research Centre
acheetham at ocad.ca            Inclusive Design Institute
                                        OCAD University




More information about the fluid-work mailing list