From cf711863cbe0b81be5ff0adfb64936137995cc4e Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Thu, 12 Dec 2024 23:39:24 +0000 Subject: [PATCH] Exclude irb from documentation generation - IRB has its own documentation in the project readme and https://ruby.github.io/irb/ already. - As a tool, its internal implementation details are not relevant to the user. - Excluding it from the documentation generation reduces the size of the generated documentation and makes search results more relevant. I also checked the there are no references to IRB so it should not break any links. --- .rdoc_options | 3 +++ lib/irb/.document | 1 - 2 files changed, 3 insertions(+), 1 deletion(-) delete mode 100644 lib/irb/.document diff --git a/.rdoc_options b/.rdoc_options index 521c1b457f2ca2..607169c5bc669c 100644 --- a/.rdoc_options +++ b/.rdoc_options @@ -7,3 +7,6 @@ title: Documentation for Ruby development version visibility: :private rdoc_include: - doc + +exclude: +- lib/irb diff --git a/lib/irb/.document b/lib/irb/.document deleted file mode 100644 index 3b0d6fa4ed6c1e..00000000000000 --- a/lib/irb/.document +++ /dev/null @@ -1 +0,0 @@ -**/*.rb