Non-public public functions: Conventions for identifying?

Cheetham, Anastasia acheetham at
Mon Nov 8 15:26:09 UTC 2010

At the dev meeting last week, we discussed the fact that there are a number of functions in the framework (and in some components) that are in the public namespace but which are not really intended for use by the general public, and which hence probably shouldn't have official documentation.

We discussed how we could identify these functions, so that the poor sod writing the documentation doesn't waste time writing things that are best left unsaid. Options included special naming conventions and an agreed-upon comment. The general consensus of those at the dev meeting was a preference for an agreed-upon comment (and NOT a special naming convention), but we wanted to throw it out to the list before we implement it.

So, thoughts?

Anastasia Cheetham     Inclusive Design Research Centre
acheetham at            Inclusive Design Institute
                                        OCAD University

More information about the fluid-work mailing list