Skip to content

⬅️ Back to Table of Contents

📄 removeSourceCodeNotice.ts

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 1

📚 Table of Contents

🛠️ File Location:

📂 packages/website/plugins/generated-rule-docs/removeSourceCodeNotice.ts

📦 Imports

Name Source
RuleDocsPage ./RuleDocsPage

Functions

removeSourceCodeNotice(page: RuleDocsPage): void

Code
export function removeSourceCodeNotice(page: RuleDocsPage): void {
  page.spliceChildren(
    page.children.findIndex(v => v.type === 'blockquote'),
    1,
  );
}
  • JSDoc:

    /**
     * Removes " 🛑 This file is source code, not the primary documentation location! 🛑".
     */
    

  • Parameters:

  • page: RuleDocsPage
  • Return Type: void
  • Calls:
  • page.spliceChildren
  • page.children.findIndex