naming: rename input arguments for runner and directives
ClosedPublic

Authored by kparal on Mar 10 2016, 9:42 AM.

Details

Summary

This renames input variables for better clarity and consistence:

  • task_data -> formula -- because it is just a parsed formula dict
  • arg_data (runner) and env_data (directives) -> arg_data -- these two input arguments were exactly the same
  • input_data -> params -- used in formulas, params is I think more clear and uses the same name we use in directive documentation (parameters key)

All of this is just proposed, if you don't like it, I can change it
back. I'm quite happy with formula and params. I was considering
some new name for arg_data, like runtime_data or runtime_vars or
run_data (proposed by @jskladan), but after some discussion in the
office we concluded we don't mind that name that much, and there are no
clear better names, so we might just leave it like that. The important
thing is that we now use the same name even in directives.

Additionally, more docstrings were added to runner classes, which
resolves T181.

Test Plan

test suite works

Diff Detail

Repository
rLTRN libtaskotron
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
kparal retitled this revision from to naming: rename input arguments for runner and directives.Mar 10 2016, 9:42 AM
kparal updated this object.
kparal edited the test plan for this revision. (Show Details)
kparal added a reviewer: libtaskotron.
kparal added a subscriber: jskladan.
lbrabec accepted this revision.Mar 10 2016, 9:52 AM
lbrabec added a reviewer: lbrabec.
lbrabec added a subscriber: lbrabec.

LGTM

This revision is now accepted and ready to land.Mar 10 2016, 9:52 AM
jskladan accepted this revision.Mar 10 2016, 9:56 AM
jskladan added a reviewer: jskladan.

Macro doge: much like very ack

mkrizek accepted this revision.Mar 10 2016, 10:19 AM
mkrizek added a reviewer: mkrizek.
tflink accepted this revision.Mar 10 2016, 4:31 PM
tflink added a reviewer: tflink.
This revision was automatically updated to reflect the committed changes.