summaryrefslogtreecommitdiffstats
path: root/lib/modifiers/summary/insertArticle.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/modifiers/summary/insertArticle.js')
-rw-r--r--lib/modifiers/summary/insertArticle.js5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/modifiers/summary/insertArticle.js b/lib/modifiers/summary/insertArticle.js
index d97943e..0a010b4 100644
--- a/lib/modifiers/summary/insertArticle.js
+++ b/lib/modifiers/summary/insertArticle.js
@@ -4,10 +4,11 @@ var editArticle = require('./editArticle');
var indexArticleLevels = require('./indexArticleLevels');
/**
- Insert an article in a summary at a specific position
+ Returns a new Summary with the article at the given level, with
+ subsequent article shifted.
@param {Summary} summary
- @param {String|Article} level: level to insert after
+ @param {String|Article} level: level to insert at
@param {Article} article
@return {Summary}
*/