Merge pull request #920 from Shopify/at-gen-doc

Enable documentation generation by default
Shopify · May 3, 2022 · b57f315 · b57f315
2 parents ed0c830 + 69f63a0
commit b57f315
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -123,6 +123,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
@@ -255,7 +256,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
@@ -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
@@ -1,7 +1,6 @@
 ---
 gem:
   exclude: []
-  doc: true
   typed_overrides:
     "net-protocol": "false"
     "net-smtp": "false"