Re: [boost] [gsoc] boost.heap update

Subject: Re: [boost] [gsoc] boost.heap update
From: Stewart, Robert (Robert.Stewart_at_[hidden])
Date: 2010-07-29 09:01:53

Tim Blechmann wrote:
>
> >> i am a bit afraid to show a piece of incorrect code. in the
> >> documentation. but is is probably clearer than just
> >> describing it with words ...
> >
> > If you have some comment like // DON'T DO THIS AT HOME
> > no harm would come from showing incorrect code, I guess.
>
> well, people may think, that you may use it, if you are supersmart ;)

If you include such a counterexample, put it on a separate page with large, red warnings, linked from the point where you describe the incorrect usage in prose.  That way, it won't be interpreted as yet another example of proper usage by appearing or being listed near normal examples.

_____
Rob Stewart                           robert.stewart_at_[hidden]
Software Engineer, Core Software      using std::disclaimer;
Susquehanna International Group, LLP  http://www.sig.com

IMPORTANT: The information contained in this email and/or its attachments is confidential. If you are not the intended recipient, please notify the sender immediately by reply and immediately delete this message and all its attachments. Any review, use, reproduction, disclosure or dissemination of this message or any attachment by an unintended recipient is strictly prohibited. Neither this message nor any attachment is intended as or should be construed as an offer, solicitation or recommendation to buy or sell any security or other financial instrument. Neither the sender, his or her employer nor any of their respective affiliates makes any warranties as to the completeness or accuracy of any of the information contained herein or that this message or any of its attachments is free of viruses.