Add missing parameter showDiff and make docstring "documentationable" #397

Merged
merged 1 commit into from May 3, 2015

Projects

None yet

2 participants

@astorije
Member

I discussed some time ago about this on #382 with @keithamus.

I couldn't find a documentation on how to make a docstring appear on the doc site, so I made the assumption that docstrings starting with /*! were ignored and those starting with /** were added to the web pages. Please make fun of me if I am completely mistaken.

This goes along with chaijs/chai-docs#80.

@astorije astorije referenced this pull request in chaijs/chai-docs Mar 10, 2015
Merged

Add assert function documentation for the plugins #80

@keithamus
Member

@astorije you are indeed correct. FYI the docs are written in dox which does indeed ignore /*!.

Unsure why these were initially written as /*! - so I might just let @logicalparadox merge this one as he might have a specific reason for using /*!

@astorije
Member

Fair enough, thanks for the update!

@keithamus keithamus merged commit 73f5d99 into chaijs:master May 3, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@astorije astorije deleted the astorije:astorije/assert-plugin-api branch May 4, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment