Skip to content

Commit 9c69472

Browse files
authored
Merge pull request #645 from jbampton/fix-grammar-and-spelling
docs: fix grammar and spelling [ci-skip]
2 parents 6bba044 + 619d552 commit 9c69472

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@
240240
`APP_ROOT/tmp/spring`, which caused problems on filesystems which did
241241
not support sockets, and also caused problems if `APP_ROOT` was
242242
sufficiently deep in the filesystem to exhaust the operating system's
243-
socket name limit. Hence we had a `SPRING_TMP_PATH` environment
243+
socket name limit. Hence, we had a `SPRING_TMP_PATH` environment
244244
variable for configuration. We now use `/tmp/spring/[md5(APP_ROOT)]`
245245
for the socket and `/tmp/spring/[md5(APP_ROOT)].pid` for the pid file.
246246
Thanks @Kriechi for the suggestion. Setting `SPRING_TMP_PATH` no longer
@@ -295,7 +295,7 @@
295295
`SPRING_LOG` environment variable.
296296
* Fix hang on "Run `bundle install` to install missing gems"
297297
* Added hack to make backtraces generated when running a command
298-
quieter (by stripping out all of the lines relating to spring)
298+
quieter (by stripping out all the lines relating to spring)
299299
* Rails 4 is officially supported
300300

301301
## 0.0.10
@@ -309,7 +309,7 @@
309309
an error either.
310310
* Don't preload `test_helper` or `spec_helper` by default. This was
311311
causing people subtle problems (for example see #113) and is perhaps
312-
surprising behaviour. It may be desirable but it depends on the
312+
surprising behaviour. It may be desirable, but it depends on the
313313
application, therefore we suggest it to people in the README but no
314314
longer do it by default.
315315
* Don't stay connected to database in the application processes. There's
@@ -342,7 +342,7 @@
342342
[console|runner|generate]`.
343343
* `config/spring.rb` is only loaded in the server process, so you can
344344
require stuff from other gems there without performance implications.
345-
* File watcher no longer pays attention to files outside of your
345+
* File watcher no longer pays attention to files outside your
346346
application root directory.
347347
* You can use the `listen` gem for less CPU intensive file watching. See
348348
README.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Rails app in `test/apps/`. On each test run, the dummy app is copied to
2020
`test/apps/tmp/` so that any changes won't affect the pre-generated app
2121
(this saves us having to regenerate the app on each run).
2222

23-
If tests are failing and you don't know why, it might be that the
23+
If tests are failing, and you don't know why, it might be that the
2424
pre-generated app has become inconsistent in some way. In that case the
2525
best solution is to purge it with `rm -rf test/apps/*` and then run the
2626
acceptance tests again, which will generate a new app.
@@ -33,7 +33,7 @@ You can set the `RAILS_VERSION` environment variable:
3333
$ RAILS_VERSION="~> 3.2.0" rake test:acceptance
3434
```
3535

36-
The apps in `test/apps` will be named based on the rails version and the
36+
The apps in `test/apps` will be named based on the rails version, and the
3737
Spring version.
3838

3939
## Testing with your app

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Gem Version](https://badge.fury.io/rb/spring.svg)](http://badge.fury.io/rb/spring)
55

66
Spring is a Rails application preloader. It speeds up development by
7-
keeping your application running in the background so you don't need to
7+
keeping your application running in the background, so you don't need to
88
boot it every time you run a test, rake task or migration.
99

1010
## Features
@@ -57,7 +57,7 @@ end
5757

5858
On platforms where Spring is installed and supported, this snippet
5959
hooks Spring into the execution of commands. In other cases, the snippet
60-
will just be silently ignored and the lines after it will be executed as
60+
will just be silently ignored, and the lines after it will be executed as
6161
normal.
6262

6363
If you don't want to prefix every command you type with `bin/`, you
@@ -179,7 +179,7 @@ Spring is running:
179179
```
180180

181181
There's no need to "shut down" Spring. This will happen automatically
182-
when you close your terminal. However if you do want to do a manual shut
182+
when you close your terminal. However, if you do want to do a manual shut
183183
down, use the `stop` command:
184184

185185
```
@@ -371,7 +371,7 @@ application restart, you can specify them with `Spring.watch`:
371371
Spring.watch "config/some_config_file.yml"
372372
```
373373

374-
By default Spring polls the filesystem for changes once every 0.2 seconds. This
374+
By default, Spring polls the filesystem for changes once every 0.2 seconds. This
375375
method requires zero configuration, but if you find that it's using too
376376
much CPU, then you can use event-based file system listening by
377377
installing the
@@ -391,24 +391,24 @@ Spring.quiet = true
391391

392392
The following environment variables are used by Spring:
393393

394-
* `DISABLE_SPRING` - If set, Spring will be bypassed and your
394+
* `DISABLE_SPRING` - If set, Spring will be bypassed, and your
395395
application will boot in a foreground process
396396
* `SPRING_LOG` - The path to a file which Spring will write log messages
397397
to.
398398
* `SPRING_TMP_PATH` - The directory where Spring should write its temporary
399-
files (a pidfile and a socket). By default we use the
399+
files (a pidfile and a socket). By default, we use the
400400
`XDG_RUNTIME_DIR` environment variable, or else `Dir.tmpdir`, and then
401401
create a directory in that named `spring-$UID`. We don't use your
402402
Rails application's `tmp/` directory because that may be on a
403403
filesystem which doesn't support UNIX sockets.
404404
* `SPRING_APPLICATION_ID` - Used to identify distinct Rails
405-
applications. By default it is an MD5 hash of the current
405+
applications. By default, it is an MD5 hash of the current
406406
`RUBY_VERSION`, and the path to your Rails project root.
407407
* `SPRING_SOCKET` - The path which should be used for the UNIX socket
408408
which Spring uses to communicate with the long-running Spring server
409-
process. By default this is `SPRING_TMP_PATH/SPRING_APPLICATION_ID`.
409+
process. By default, this is `SPRING_TMP_PATH/SPRING_APPLICATION_ID`.
410410
* `SPRING_PIDFILE` - The path which should be used to store the pid of
411-
the long-running Spring server process. By default this is related to
411+
the long-running Spring server process. By default, this is related to
412412
the socket path; if the socket path is `/foo/bar/spring.sock` the
413413
pidfile will be `/foo/bar/spring.pid`.
414414
* `SPRING_SERVER_COMMAND` - The command to run to start up the Spring

0 commit comments

Comments
 (0)