From 69f63a0bba3998c4c77df18f401782eb94a26ab0 Mon Sep 17 00:00:00 2001 From: Alexandre Terrasa Date: Tue, 3 May 2022 12:10:34 -0400 Subject: [PATCH] Enable documentation generation by default Signed-off-by: Alexandre Terrasa --- README.md | 3 ++- lib/tapioca/cli.rb | 2 +- sorbet/tapioca/config.yml | 1 - 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad65698fd..667aa1240 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,7 @@ Options: # Default: {"activesupport"=>"false"} [--verify], [--no-verify] # Verify RBIs are up-to-date [--doc], [--no-doc] # Include YARD documentation from sources when generating RBIs. Warning: this might be slow + # Default: true [--exported-gem-rbis], [--no-exported-gem-rbis] # Include RBIs found in the `rbi/` directory of the gem # Default: true -w, [--workers=N] # EXPERIMENTAL: Number of parallel workers to use when generating RBIs @@ -247,7 +248,7 @@ gem: typed_overrides: activesupport: 'false' verify: false - doc: false + doc: true exported_gem_rbis: true workers: 1 auto_strictness: true diff --git a/lib/tapioca/cli.rb b/lib/tapioca/cli.rb index f7630e564..fb056d1a6 100644 --- a/lib/tapioca/cli.rb +++ b/lib/tapioca/cli.rb @@ -172,7 +172,7 @@ def dsl(*constants) option :doc, type: :boolean, desc: "Include YARD documentation from sources when generating RBIs. Warning: this might be slow", - default: false + default: true option :exported_gem_rbis, type: :boolean, desc: "Include RBIs found in the `rbi/` directory of the gem", diff --git a/sorbet/tapioca/config.yml b/sorbet/tapioca/config.yml index a619b1329..b7227da0e 100644 --- a/sorbet/tapioca/config.yml +++ b/sorbet/tapioca/config.yml @@ -1,7 +1,6 @@ --- gem: exclude: [] - doc: true typed_overrides: "net-protocol": "false" "net-smtp": "false"