Skip to content

Commit 01f3b68

Browse files
committed
Fix typo and wording
1 parent 746f095 commit 01f3b68

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ $ tapioca help
7171

7272
Commands:
7373
tapioca --version, -v # Show version
74-
tapioca annotations # [deprecated] Pull gem RBI annotations from remote sources
74+
tapioca annotations # [removed] Pull gem RBI annotations from remote sources
7575
tapioca check-shims # Check duplicated definitions in shim RBIs
7676
tapioca configure # Initialize folder structure and type checking configuration
7777
tapioca dsl [constant...] # Generate RBIs for dynamic methods
@@ -333,7 +333,7 @@ This option can be used on CI to make sure the RBI files are always up-to-date a
333333
334334
Since Tapioca does not perform any type inference, the RBI files generated for the gems do not contain any type signatures. Instead, Tapioca relies on the community to provide high-quality, manually written RBI annotations for public gems. These annotations are sourced and combined with the generated RBIs as a step during `tapioca gem`.
335335
336-
By default, Tapioca will pull the annotations stored in the central repository located at https://github.com/Shopify/rbi-central. It is possible to use a custom repository by changing the value of the `--annotations-sources` option. For example if your repository is stored on Github:
336+
By default, Tapioca will pull the annotations stored in the central repository located at https://github.com/Shopify/rbi-central. It is possible to use a custom repository by changing the value of the `--annotations-sources` option. For example if your repository is stored on GitHub:
337337
338338
```shell
339339
$ bin/tapioca gem --annotations-sources https://raw.githubusercontent.com/$USER/$REPO/$BRANCH
@@ -347,7 +347,7 @@ $ bin/tapioca gem --annotations-sources https://raw.githubusercontent.com/$USER/
347347
348348
##### Basic authentication
349349
350-
Private repositories can be used as sources by passing the option `--auth` with an authentication string. For Github, this string is `token $TOKEN` where `$TOKEN` is a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token):
350+
Private repositories can be used as sources by passing the option `--auth` with an authentication string. For GitHub, this string is `token $TOKEN` where `$TOKEN` is a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token):
351351
352352
```shell
353353
$ bin/tapioca gem --annotations-sources https://raw.githubusercontent.com/$USER/$PRIVATE_REPO/$BRANCH --annotations-auth "token $TOKEN"
@@ -365,7 +365,7 @@ machine raw.githubusercontent.com
365365
password $TOKEN
366366
```
367367
368-
where `$USERNAME` is your Github username and `$TOKEN` is a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), then, if you run Tapioca with the `--annotations-netrc` option (enabled by default), your annotation requests should be authenticated properly.
368+
where `$USERNAME` is your GitHub username and `$TOKEN` is a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), then, if you run Tapioca with the `--annotations-netrc` option (enabled by default), your annotation requests should be authenticated properly.
369369
370370
The `--annotations-netrc-file` option can be specified to read from a file other than `~/.netrc`:
371371

lib/tapioca/cli.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ def check_shims
352352
command.run
353353
end
354354

355-
desc "annotations", "[deprecated] Pull gem RBI annotations from remote sources"
355+
desc "annotations", "[removed] Pull gem RBI annotations from remote sources"
356356
option :sources,
357357
type: :array,
358358
default: [CENTRAL_REPO_ROOT_URI],
@@ -368,7 +368,7 @@ def check_shims
368368
default: {}
369369
def annotations
370370
raise Thor::Error, set_color(
371-
"`tapioca annotation` has been deprecated." \
371+
"`tapioca annotation` has been removed." \
372372
"The functionality has been merged into `tapioca gem`. Please use that instead.",
373373
:bold,
374374
:red,

lib/tapioca/commands/abstract_gem.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ def say_http_error(path, repo_uri, message:)
483483
Tapioca can't access the annotations at #{repo_uri}.
484484
485485
Are you trying to access a private repository?
486-
If so, please specify your Github credentials in your ~/.netrc file or by specifying the --auth option.
486+
If so, please specify your GitHub credentials in your ~/.netrc file or by specifying the --auth option.
487487
488488
See https://github.com/Shopify/tapioca#using-a-netrc-file for more details.
489489
ERROR

spec/tapioca/cli/gem_spec.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -2458,7 +2458,7 @@ class AnnotationForBar; end
24582458
Tapioca can't access the annotations at https://bad-source.
24592459
24602460
Are you trying to access a private repository?
2461-
If so, please specify your Github credentials in your ~/.netrc file or by specifying the --auth option.
2461+
If so, please specify your GitHub credentials in your ~/.netrc file or by specifying the --auth option.
24622462
24632463
See https://github.com/Shopify/tapioca#using-a-netrc-file for more details.
24642464
ERROR

0 commit comments

Comments
 (0)