[PATCH] Planner: Add comments to document the code

[Dirk Hohndel]

On Mon, Jul 27, 2015 at 10:06:02PM +1000, Rick Walsh wrote:
> The purpose of parts of the planner code is not not always obvious.  This is
> especially true of the conditional statements in the add_plan_to_notes function.
> Annotate the code with comments to explain the logic.

Thank you...  I'm often frustrated when trying to go back and addressing
problems or bugs later to find out that it takes me quite a while to
understand certain parts of the code once again. Usually going back and
looking at commit messages helps, but overall it would be better if we
were more dilligent commenting our code.

Thanks, Rick.

/D