Add missing docstring for showDiff argument of assert #382

Merged
merged 1 commit into from Mar 1, 2015

Projects

None yet

2 participants

@astorije
Member

Considering this assert method is extensively used when you build your own helper, I think it should be added to the Plugin Utilities API page.

What do you think?

@keithamus
Member

I think that is a great idea @astorije. Do you want to raise a separate issue for it?

As for this PR. Thanks for your work on it, looks good 😄.

@keithamus keithamus merged commit 062d731 into chaijs:master Mar 1, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@astorije
Member
astorije commented Mar 1, 2015

Hey @keithamus! Actually yes, the arguments are described in the guide.

Do you still think it's worth adding an entry in the API page as well?
If so, should it be at the same level than .type(), .addMethod(), ... even if they are all methods of utils while assert is a method of Assertion?

Just trying to see where I can put that if I open a PR.

@keithamus
Member

I don't have strong opinions on this - if you see a gap in the docs, fill it to how you'd like to see the docs become. I trust your judgement 😄

@astorije astorije deleted the astorije:patch-2 branch Mar 9, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment