Add example to JSdoc

metalsmith · Aug 5, 2022 · 9427720 · 9427720
1 parent 342b5e6
commit 9427720
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/index.js b/src/index.js
@@ -26,8 +26,12 @@ function isDraft(value, fallback) {
 /**
  * Metalsmith plugin to hide drafts from the output.
  *
- * @param {Options} [options]
+ * @param {Options|boolean} [options]
  * @returns {import('metalsmith').Plugin}
+ * @example
+ * metalsmith.use(drafts()) // same as { include: false }
+ * metalsmith.use(drafts(true)) // same as { include: true }
+ * metalsmith.use(drafts({ default: false, include: false })) // same as default
  */
 function configureDrafts(options = defaultOptions) {
  if (typeof options === 'boolean') {