Skip to content
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 parameter showDiff and make docstring "documentationable" #397

Merged
merged 1 commit into from May 3, 2015

Conversation

@astorije
Copy link
Member

@astorije astorije commented Mar 10, 2015

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/chaijs.github.io#80.

@keithamus
Copy link
Member

@keithamus keithamus commented Mar 10, 2015

@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
Copy link
Member Author

@astorije astorije commented Mar 10, 2015

Fair enough, thanks for the update!

keithamus added a commit that referenced this pull request May 3, 2015
Add missing parameter showDiff and make docstring "documentationable"
@keithamus keithamus merged commit 73f5d99 into chaijs:master May 3, 2015
1 check passed
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
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants