New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing docstring for showDiff argument of assert #382

Merged
merged 1 commit into from Mar 1, 2015

Conversation

Projects
None yet
2 participants
@astorije
Member

astorije commented Feb 28, 2015

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

This comment has been minimized.

Member

keithamus commented Mar 1, 2015

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 added a commit that referenced this pull request Mar 1, 2015

Merge pull request #382 from astorije/patch-2
Add missing docstring for showDiff argument of assert

@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

This comment has been minimized.

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

This comment has been minimized.

Member

keithamus commented Mar 1, 2015

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 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment