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

Add description to rake generate:stdlib_test[class] #578

Merged
merged 1 commit into from
Jan 19, 2021
Merged

Add description to rake generate:stdlib_test[class] #578

merged 1 commit into from
Jan 19, 2021

Conversation

ybiquitous
Copy link
Contributor

The document stdlib.md describes the command rake generate:stdlib_test[class].
(see https://github.com/ruby/rbs/blob/018f671ed048975acf68fd40412f91e90600aa16/docs/stdlib.md#writing-tests)

So, I think it useful that the rake task is output via rake --tasks:

$ bundle exec rake --tasks
rake build                        # Build rbs-1.0.0.gem into the pkg directory
rake clean                        # Remove any temporary products
rake clobber                      # Remove any generated files
rake generate:stdlib_test[class]  # Generate a test file for a stdlib class signatures
rake install                      # Build and install rbs-1.0.0.gem into system gems
rake install:local                # Build and install rbs-1.0.0.gem into system gems without network access
rake release[remote]              # Create tag v1.0.0 and build and push rbs-1.0.0.gem to rubygems.org
rake test                         # Run tests

The document `stdlib.md` describes the command `rake generate:stdlib_test[class]`.
(see <https://github.com/ruby/rbs/blob/018f671ed048975acf68fd40412f91e90600aa16/docs/stdlib.md#writing-tests>)

So, I think it useful that the rake task is output via `rake --tasks`:

```console
$ bundle exec rake --tasks
rake build                        # Build rbs-1.0.0.gem into the pkg directory
rake clean                        # Remove any temporary products
rake clobber                      # Remove any generated files
rake generate:stdlib_test[class]  # Generate a test file for a stdlib class signatures
rake install                      # Build and install rbs-1.0.0.gem into system gems
rake install:local                # Build and install rbs-1.0.0.gem into system gems without network access
rake release[remote]              # Create tag v1.0.0 and build and push rbs-1.0.0.gem to rubygems.org
rake test                         # Run tests
```
Copy link
Member

@pocke pocke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🌟
Thanks!

@pocke pocke merged commit 590bac7 into ruby:master Jan 19, 2021
@ybiquitous ybiquitous deleted the add-desc-to-stdlib_test-rake-task branch January 19, 2021 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants