summaryrefslogtreecommitdiffstats
path: root/lib/modifiers/summary/moveArticleAfter.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/modifiers/summary/moveArticleAfter.js')
-rw-r--r--lib/modifiers/summary/moveArticleAfter.js4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/modifiers/summary/moveArticleAfter.js b/lib/modifiers/summary/moveArticleAfter.js
index e03eae9..e268f73 100644
--- a/lib/modifiers/summary/moveArticleAfter.js
+++ b/lib/modifiers/summary/moveArticleAfter.js
@@ -3,7 +3,9 @@ var removeArticle = require('./removeArticle');
var insertArticle = require('./insertArticle');
/**
- Returns a new summary, with the an article moved after another article.
+ Returns a new summary, with the an article moved after another
+ article. Unlike `moveArticle`, does not ensure that the article
+ will be found at the target's level plus one.
@param {Summary} summary
@param {String|SummaryArticle} origin