diff options
author | The Bundler Bot <bot@bundler.io> | 2017-08-03 04:46:25 +0000 |
---|---|---|
committer | The Bundler Bot <bot@bundler.io> | 2017-08-03 04:46:25 +0000 |
commit | c4ae85f01edca72d48c617be07440c2cd600ab4f (patch) | |
tree | 2f76f6858628be499b28e16cbd269638943d8023 | |
parent | 4e6cad69dbd539b8118c5bef1b9481e86a3247f4 (diff) | |
parent | 5f602f837b1d383cbca99c232a0ebd22ce4a9722 (diff) | |
download | bundler-c4ae85f01edca72d48c617be07440c2cd600ab4f.tar.gz |
Auto merge of #5917 - arbonap:pa-doc-specs, r=colby-swandale
Include `bin/rspec` in directions to test doc changes
Thanks so much for the contribution!
To make reviewing this PR a bit easier, please fill out answers to the following questions.
### What was the end-user problem that led to this PR?
The problem was...
- I was updating documentation in a `.ronn` file. I struggled a bit when I tried testing my doc changes. When I tried running `rspec ./spec/commands/help_spec.rb` and `rspec ./spec/quality_spec.rb`, I kept getting this error:
```
uninitialized constant Bundler::EnvironmentPreserver::BUNDLER_PREFIX (NameError)
Did you mean? Bundler::BundlerError
```
### What was your diagnosis of the problem?
My diagnosis was...
- @colby-swandale told me that I should run`bin/rspec` instead of `rspec`. It worked 🎈
### What is your fix for the problem, implemented in this PR?
My fix...
- To add in `bin/rspec` to the ["Writing docs for man pages" documentation](https://github.com/bundler/bundler/blob/master/doc/documentation/WRITING.md)
### Why did you choose this fix out of the possible options?
I chose this fix because...
- Hopefully this could help someone else save some time on their hands and prevent them from getting the same error I did.[[selfie-0 uploading...]]
[[selfie-1 uploading...]]
[[selfie-2 uploading...]]
-rw-r--r-- | doc/documentation/WRITING.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/documentation/WRITING.md b/doc/documentation/WRITING.md index ce6dcce653..bc678b7c55 100644 --- a/doc/documentation/WRITING.md +++ b/doc/documentation/WRITING.md @@ -49,6 +49,6 @@ If you make more changes to `bundle-cookies.ronn`, you'll need to run the `rake We have tests for our documentation! The most important test file to run before you make your pull request is the one for the `help` command and another for documentation quality. ``` -$ rspec ./spec/commands/help_spec.rb -$ rspec ./spec/quality_spec.rb +$ bin/rspec ./spec/commands/help_spec.rb +$ bin/rspec ./spec/quality_spec.rb ``` |