Browse Source

Add jsdoc for prepareAttachmentTextForUpdate()

Shun Miyazawa 2 years ago
parent
commit
5c6c4f94cd
1 changed files with 6 additions and 0 deletions
  1. 6 0
      apps/app/src/server/util/slack.js

+ 6 - 0
apps/app/src/server/util/slack.js

@@ -24,6 +24,12 @@ const prepareAttachmentTextForCreate = function(page, siteUrl) {
   return convertMarkdownToMarkdown(body, siteUrl);
 };
 
+/**
+ * Return diff with latest revisionBody
+ * @param {IPageHasId} page
+ * @param {string} siteUrl
+ * @param {IRevisionHasId} previousRevision
+ */
 const prepareAttachmentTextForUpdate = function(page, siteUrl, previousRevision) {
   if (previousRevision == null) {
     return;