Documentation for dirty and mark_dirty Incorrect

[GroveDG]

taffy version

0.4.1

Platform

Documentation

What went wrong

The mark_dirty and dirty functions on TaffyTree refer to marking children as outdated, but mark_dirty marks parents (and so on) as outdated.

Additional information

It could also be that the documentation is what it's supposed to do and the code is wrong. I'm not sure.

[nicoburns]

Pretty sure the docs are wrong here as you suspected. I reckon mark_dirty ought to be "node and it's parents/ancestors" and dirty probably ought to just say "the node" and not talk about parents/children at all.