ojwoodford / batch_job

Parallelize MATLAB for loops across workers, without the Parallel Computing Toolbox
MIT License
18 stars 6 forks source link

Documentation unclear for use of "input" and "global_data" #2

Closed jasonnicholson closed 7 years ago

jasonnicholson commented 7 years ago

I am having trouble understanding what you mean in the batch_job function documentation (the troublesome section is listed below). Please consider adding examples or demos of "global_data" use.

For instance, do you mean that func is called like this without _globaldata specified: func(input(i))? When you use globalData, is it called like this instead: func(globalData(i))? Or is it this func(input(i), globalData)? Or something else?

Can you see how an example or demo would clear this up?

clipboard01

oliverwoodfordsc commented 7 years ago

Good feedback. From memory I think it's func(input(i), globalData), but I'll check and add an example soon. Thanks.

oliverwoodfordsc commented 7 years ago

The readme example makes it clear that it's func(input(i), globalData). I'll add this the help text.

jasonnicholson commented 7 years ago

Okay. Thank you.

ojwoodford commented 7 years ago

I've updated the help text with some examples