Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable documentation generation by default #920

Merged
merged 1 commit into from May 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -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
Expand Down Expand Up @@ -247,7 +248,7 @@ gem:
typed_overrides:
activesupport: 'false'
verify: false
doc: false
doc: true
exported_gem_rbis: true
workers: 1
auto_strictness: true
Expand Down
2 changes: 1 addition & 1 deletion lib/tapioca/cli.rb
Expand Up @@ -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",
Expand Down
1 change: 0 additions & 1 deletion sorbet/tapioca/config.yml
@@ -1,7 +1,6 @@
---
gem:
exclude: []
doc: true
typed_overrides:
"net-protocol": "false"
"net-smtp": "false"
Expand Down