grunt-phpunit icon indicating copy to clipboard operation
grunt-phpunit copied to clipboard

documentation of repeat option could use some improving

Open johnmarty opened this issue 10 years ago • 2 comments

Hi Sascha and Team,

Great plugin. I've enjoyed it tremendously. I wanted to ask you to improve the documentation on the options a few weeks ago when I first configured it and just now I spent more time horsing around with "repeat" before it dawned on me boolean:true was not going to work. I saw "string" and all the memories came back about how confusing it is to see a default boolean and then a "string" listed as the type. So instead of spending a lot of time copying verbatim the documentation from phpunit just reference it and remove the duplication in your readme.

see phpunit documentation

Then only note arguments that you may not pass through or have added/altered/aliased.

Again, great work, thanks for sharing.

johnmarty avatar Oct 31 '14 02:10 johnmarty

maybe offer phpunit --h as another way to get the list too

johnmarty avatar Oct 31 '14 02:10 johnmarty

Hi John,

according to the phpunit documentation, the "repeat" option is not a boolean type but rather a specification of the number of repetitions. So a string type is appropriate in this case. We may discuss though, if it should be an integer type.

Regarding your concerns about documentation: it all started out as a little phpunit wrapper with only the most common options and grew after time. But that does not mean, that each and every option of phpunit is already implemented. Furthermore, the plugin is not tied to a specific phpunit version, so available options may vary. From this point of view, it is necessary to list the available (wrapped) options.

Br, Sascha

SaschaGalley avatar Oct 31 '14 07:10 SaschaGalley