Clarify that submission_tmpl()
can take either a hub connection OR a config file
#137
Labels
submission_tmpl()
can take either a hub connection OR a config file
#137
I was recently exploring the
submission_tmpl()
function and it looks like it's really useful! When I tried to run it the first time, I assumed that bothhub_con
,config_tasks
, andround_id
were all required (since they didn't have defaults), but I got this error:Simple fix
Clearly state in the documentation that
hub_con
andconfig_tasks
are mutually exclusive (e.g. in the arguments themselves).This fix won't prevent people from doing what I did, but at least there will be a sign that instructs them about the right way to do it.
Robust fix
Make
submission_tmpl()
an S3 method forhub_connection
andconfig
classes and remove theconfig_tasks
argument.I consider this a more robust fix because the function really only needs the config be it accessed through a hub or the config object directly. We could even add a method for
character
objects to read from a file (it should probably be a path to a hub).The text was updated successfully, but these errors were encountered: