|
1 | 1 | <!--- |
2 | | -This file was generated on 2019-12-05T21:32:23+00:00 from the rspec-dev repo. |
| 2 | +This file was generated on 2020-12-25T18:48:30+00:00 from the rspec-dev repo. |
3 | 3 | DO NOT modify it by hand as your changes will get lost the next time it is generated. |
4 | 4 | --> |
5 | 5 |
|
@@ -112,22 +112,23 @@ $ bundle exec yard doc --no-cache |
112 | 112 | $ bin/yard doc --no-cache |
113 | 113 | ``` |
114 | 114 |
|
115 | | -## Rubocop |
| 115 | +## RuboCop |
116 | 116 |
|
117 | | -We use [Rubocop](https://github.com/rubocop-hq/rubocop) to enforce style conventions on the project so |
118 | | -that the code has stylistic consistency throughout. Run with: |
| 117 | +We use [RuboCop](https://github.com/rubocop-hq/rubocop) to enforce style |
| 118 | +conventions on the project so that the code has stylistic consistency |
| 119 | +throughout. Run with: |
119 | 120 |
|
120 | 121 | ``` |
121 | | -$ bundle exec rubocop |
| 122 | +$ bundle exec rubocop lib |
122 | 123 |
|
123 | 124 | # or, if you installed your bundle with `--standalone --binstubs`: |
124 | 125 |
|
125 | | -$ bin/rubocop |
| 126 | +$ bin/rubocop lib |
126 | 127 | ``` |
127 | 128 |
|
128 | | -Our Rubocop configuration is a work-in-progress, so if you get a failure |
129 | | -due to a Rubocop default, feel free to ask about changing the |
130 | | -configuration. Otherwise, you'll need to address the Rubocop failure, |
| 129 | +Our RuboCop configuration is a work-in-progress, so if you get a failure |
| 130 | +due to a RuboCop default, feel free to ask about changing the |
| 131 | +configuration. Otherwise, you'll need to address the RuboCop failure, |
131 | 132 | or, as a measure of last resort, by wrapping the offending code in |
132 | 133 | comments like `# rubocop:disable SomeCheck` and `# rubocop:enable SomeCheck`. |
133 | 134 |
|
@@ -161,4 +162,3 @@ build for another repo, so our CI build includes a spec that runs the |
161 | 162 | spec suite of each of the _other_ project repos. Note that we only run |
162 | 163 | the spec suite, not the full build, of the other projects, as the spec |
163 | 164 | suite runs very quickly compared to the full build. |
164 | | - |
0 commit comments