diff options
author | Soreine <nicolas@gitbook.com> | 2016-05-03 13:11:32 +0200 |
---|---|---|
committer | Soreine <nicolas@gitbook.com> | 2016-05-03 13:11:32 +0200 |
commit | 4ebe28faaebb8752107ef6cfa6253f7b6f8a2a86 (patch) | |
tree | 55ebc7200209f46093ed6b43c5a2007adaea6610 /lib/modifiers/summary/insertArticle.js | |
parent | 693171cb0544c900cb964b0b6015ca528aa776f2 (diff) | |
download | gitbook-4ebe28faaebb8752107ef6cfa6253f7b6f8a2a86.zip gitbook-4ebe28faaebb8752107ef6cfa6253f7b6f8a2a86.tar.gz gitbook-4ebe28faaebb8752107ef6cfa6253f7b6f8a2a86.tar.bz2 |
Update insert specification
Diffstat (limited to 'lib/modifiers/summary/insertArticle.js')
-rw-r--r-- | lib/modifiers/summary/insertArticle.js | 5 |
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} */ |