summaryrefslogtreecommitdiffstats
path: root/lib/api
diff options
context:
space:
mode:
authorSamy Pesse <samypesse@gmail.com>2016-05-08 22:26:46 +0200
committerSamy Pesse <samypesse@gmail.com>2016-05-08 22:26:46 +0200
commitbb910f984edd8080e5fe1d1b34a7dfec7ac9d785 (patch)
treec9c36a6f76b246332f70690c5ecb8cca52dfdb26 /lib/api
parentc7864927ecdfce09e29488a97358b797dcfdcfa3 (diff)
downloadgitbook-bb910f984edd8080e5fe1d1b34a7dfec7ac9d785.zip
gitbook-bb910f984edd8080e5fe1d1b34a7dfec7ac9d785.tar.gz
gitbook-bb910f984edd8080e5fe1d1b34a7dfec7ac9d785.tar.bz2
Improve comment for API summary.walk
Diffstat (limited to 'lib/api')
-rw-r--r--lib/api/encodeSummary.js2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/api/encodeSummary.js b/lib/api/encodeSummary.js
index f1a7d97..0d66ded 100644
--- a/lib/api/encodeSummary.js
+++ b/lib/api/encodeSummary.js
@@ -10,7 +10,7 @@ var encodeSummaryArticle = require('../json/encodeSummaryArticle');
function encodeSummary(output, summary) {
var result = {
/**
- Iterate over the summary
+ Iterate over the summary, it stops when the "iter" returns false
@param {Function} iter
*/