Mirrors/chai
2
0
Fork 0
mirror of https://github.com/chaijs/chai synced 2024-11-15 00:07:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs cleanup

Browse source
This commit is contained in:
Jake Luer 2012-02-10 11:32:44 -05:00
parent abdcf3786d
commit 3fdd508721
3 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Makefile
View file

@ -1,6 +1,6 @@
TESTS = test/*.js
REPORTER = dot
REPORTER = spec
SRC = $(shell find lib -name "*.js" -type f)
all: chai.js
@ -12,10 +12,11 @@ clean:
rm -f chai.js
docs: clean-docs
@./node_modules/.bin/codex build docs \
--out docs/out
@./node_modules/.bin/codex build \
-i docs
@cp chai.js docs/out/chai.js
@./node_modules/.bin/codex serve \
--out docs/out
-d docs/out
clean-docs:
@rm -rf docs/out
@ -26,4 +27,4 @@ test:
--ui tdd \
$(TESTS)
.PHONY: clean test docs clean-docs
.PHONY: clean test docs clean-docs

5
chai.js
View file

@ -1460,12 +1460,11 @@ module.exports = function (chai) {
};
/**
* # .throws(function, [constructor], [message])
* # .throws(function, [constructor/regexp], [message])
*
* Assert that a function will throw a specific
* type of error.
*
* var fn = function () { throw new ReferenceError(''); }
* assert.throw(fn, ReferenceError, 'function throw reference error');
*
* @name throws
@ -1487,7 +1486,7 @@ module.exports = function (chai) {
};
/**
* # .doesNotThrow(function, [constructor], [message])
* # .doesNotThrow(function, [constructor/regexp], [message])
*
* Assert that a function will throw a specific
* type of error.

5
lib/interface/assert.js
View file

@ -471,12 +471,11 @@ module.exports = function (chai) {
};
/**
* # .throws(function, [constructor], [message])
* # .throws(function, [constructor/regexp], [message])
*
* Assert that a function will throw a specific
* type of error.
*
* var fn = function () { throw new ReferenceError(''); }
* assert.throw(fn, ReferenceError, 'function throw reference error');
*
* @name throws
@ -498,7 +497,7 @@ module.exports = function (chai) {
};
/**
* # .doesNotThrow(function, [constructor], [message])
* # .doesNotThrow(function, [constructor/regexp], [message])
*
* Assert that a function will throw a specific
* type of error.