search

matsengrp / larch

Inference and manipulation of history DAGs
2 stars 2 forks source link

WD-Documentation #11

Closed willdumm closed 2 years ago

willdumm commented 2 years ago

An initial pass through all the header files, adding comments. These docs are fairly superficial, describing only classes and methods not entirely described by their names. I learned a lot going through the code in detail.

@ognian- when you get a chance I'd love to know if any of what I've written is wrong. I also wasn't quite sure what to say about TraverseValue. I think I don't quite understand its purpose.

This is a better version of #10 which won't require awful rebasing

willdumm commented 2 years ago

As far as I can tell, the docs are now building correctly.