docs/stdlib.md in rbs-0.3.1 vs docs/stdlib.md in rbs-0.4.0
- old
+ new
@@ -1,8 +1,8 @@
# Stdlib Signatures Guide
-This is a guide for contributing to `ruby-signature` by writing/revising stdlib signatures.
+This is a guide for contributing to `rbs` by writing/revising stdlib signatures.
The typical steps of writing signatures will be like the following:
1. Generate a prototype
2. Import RDoc document
@@ -15,11 +15,11 @@
To write signatures see [syntax guide](syntax.md).
## Generating prototypes
-`ruby-signature` provides a tool to generate a prototype of signatures, `rbs prototype`.
+`rbs` provides a tool to generate a prototype of signatures, `rbs prototype`.
It provides several options, `rbi` from Sorbet RBI files, `rb` from Ruby code, and `runtime` from runtime API.
`runtime` should be the best option for standard libraries because they may be implemented in C, no Ruby source code.
The tool `require`s all of the libraries specified with `-r` option, and then use introspection APIs like `instance_methods` to know the structure of the class.
The commandline receives the name of classes you want to prototype, exact class name (like `Pathname`) or pattern with `*` (like `IO::*`).
@@ -145,8 +145,8 @@
### Running tests
You can run the test with:
```
-$ bundle exec ruby bin/test_runner.rb # Run all tests
+$ bundle exec rake stdlib_test # Run all tests
$ bundle exec ruby test/stdlib/String_test.rb # Run specific tests
```