Runner and BaseDirective objects have no documentation, yet they are quite complex. There is a lot of different similarly-named attributes, like taskdata, argdata, envdata, working_data. There is a lot of abstraction and interfaces (calling actions, calling directives).
Runner
BaseDirective
taskdata
argdata
envdata
working_data
Please document the code. It's going to make further contributions easier.
This ticket had assigned some Differential requests: D130 D772
Since I'm rewriting task yaml handling a bit in #169, I'll add Runner documentation as well. BaseDirective docs are still needed.
Correction: There's still a lot to document in Runner as well. I added just some bits.
@kparal, do you think that this ticket is still needed?
I've done some simplifications in D130, which reduced the amount of things we need to document, but it didn't get committed in the end. I'll take this ticket and look at it, whether we need to document something or not.
any update on this and whether Runner and BaseDirective still need more documentation?
To this day I don't remember what the difference is between argdata, envdata and taskdata and I don't see any description anywhere so I need to always read the code, but due to many changes I think the situation is a bit better now (some methods now have docstrings). I'd still hold to this ticket, though, with a hope for that rainbow day when I go through all of it again and clarify it better, provided nobody objects :)
Fixed in D772.
Login to comment on this ticket.