Update callable JSDoc comment

chaijs · Jan 15, 2024 · 95d7fda · 95d7fda
1 parent 96ff526
commit 95d7fda
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/lib/chai/core/assertions.js b/lib/chai/core/assertions.js
@@ -673,7 +673,19 @@ Assertion.addProperty('true', function () {
 });
 
 /**
- * TODO
+ * ### .callable
+ *
+ * Asserts that the target a callable function.
+ *
+ *     expect(console.log).to.be.callable;
+ *
+ * A custom error message can be given as the second argument to `expect`.
+ *
+ *     expect('not a function', 'nooo why fail??').to.be.callable;
+ *
+ * @name callable
+ * @namespace BDD
+ * @api public
  */
 Assertion.addProperty('callable', function () {
   const val = flag(this, 'object')