[llvm-commits] [PATCH] Enable edge pruning in PostOrderIterator.h

[Sean Silva]

> They would go stale faster than you can type them.

Good point. Thanks for beefing up the docs :-)

--Sean Silva

On Tue, Jul 17, 2012 at 8:41 AM, Jakob Stoklund Olesen <stoklund at 2pi.dk> wrote:
>
> On Jul 16, 2012, at 10:39 PM, Sean Silva <silvas at purdue.edu> wrote:
>
>> Please make sure that this, the functionality you add in this patch,
>> and any other "goodies" are clearly documented at the top of the file
>> in a nice big comment (that preferably also contains a "quickstart"
>> example). I really, _really_ like the format that you have used in
>> this email for describing the feature, namely "It is possible to do X
>> by providing a custom Y, see for example Z which uses this
>> functionality to do W". The goal is that by just reading the file
>> header, a person can get a good idea of whether or not po_iterator is
>> capable of doing what they are looking for.
>
> I've added a block comment, but we can't add back-references to the library clients like you suggest. They would go stale faster than you can type them. Programmers can use 'git grep' to find examples.
>
> Committed in r160366.
>
> Thanks,
>
> /jakob
>