On 03/04/2011 10:02 PM, [email protected] wrote:
Hi, Steve.  I approved this, but Andrew had a good question: whither old
api examples?

I'm personally conflicted on whether it's best to include them. I lean,
however, toward removing them. Examples are principally documentation
for new work, and new work should use the new apis.

Sorry if this was already discussed. I didn't find anything apart from
QPID-3067, and that doesn't contain a conclusion.

It doesn't contain a conclusion, but as raised it suggested renaming rather than removing and this was backed up by one of the comments.

While my own inclination was to remove them, that seemed the more extreme approach and the renaming does very clearly signal the intent.

Arguably, since the old headers are all still included along with the new headers, having these examples there and clearly marked as 'old' actually makes their status clearer. Really we should be marking the old APIs deprecated in doxygen I think.

My view would probably be that we leave this as is for now (i.e. renamed) but aim to more clearly deprecate the APIs in the next release (while still supporting them) and remove the examples at that time. However I'm not opposed to other solutions including their removal for this release if others feel strongly enough.


---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project:      http://qpid.apache.org
Use/Interact: mailto:[email protected]

Reply via email to