Skip to content

Commit 619d552

Browse files
committed
docs: fix grammar and spelling [ci-skip]
1 parent 577cf01 commit 619d552

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

CHANGELOG.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@
232232
`APP_ROOT/tmp/spring`, which caused problems on filesystems which did
233233
not support sockets, and also caused problems if `APP_ROOT` was
234234
sufficiently deep in the filesystem to exhaust the operating system's
235-
socket name limit. Hence we had a `SPRING_TMP_PATH` environment
235+
socket name limit. Hence, we had a `SPRING_TMP_PATH` environment
236236
variable for configuration. We now use `/tmp/spring/[md5(APP_ROOT)]`
237237
for the socket and `/tmp/spring/[md5(APP_ROOT)].pid` for the pid file.
238238
Thanks @Kriechi for the suggestion. Setting `SPRING_TMP_PATH` no longer
@@ -287,7 +287,7 @@
287287
`SPRING_LOG` environment variable.
288288
* Fix hang on "Run `bundle install` to install missing gems"
289289
* Added hack to make backtraces generated when running a command
290-
quieter (by stripping out all of the lines relating to spring)
290+
quieter (by stripping out all the lines relating to spring)
291291
* Rails 4 is officially supported
292292

293293
## 0.0.10
@@ -301,13 +301,13 @@
301301
an error either.
302302
* Don't preload `test_helper` or `spec_helper` by default. This was
303303
causing people subtle problems (for example see #113) and is perhaps
304-
surprising behaviour. It may be desirable but it depends on the
304+
surprising behaviour. It may be desirable, but it depends on the
305305
application, therefore we suggest it to people in the README but no
306306
longer do it by default.
307307
* Don't stay connected to database in the application processes. There's
308308
no need to keep a connection open.
309309
* Avoid using the database in the application processes. Previously,
310-
reloading the autoloaded constants would inadvertantly cause a
310+
reloading the autoloaded constants would inadvertently cause a
311311
connection to the database, which would then prevent tasks like
312312
db:create from running (because at that point the database doesn't
313313
exist)
@@ -334,7 +334,7 @@
334334
[console|runner|generate]`.
335335
* `config/spring.rb` is only loaded in the server process, so you can
336336
require stuff from other gems there without performance implications.
337-
* File watcher no longer pays attention to files outside of your
337+
* File watcher no longer pays attention to files outside your
338338
application root directory.
339339
* You can use the `listen` gem for less CPU intensive file watching. See
340340
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
@@ -56,7 +56,7 @@ end
5656

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

6262
If you don't want to prefix every command you type with `bin/`, you
@@ -168,7 +168,7 @@ Spring is running:
168168
```
169169

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

174174
```
@@ -362,7 +362,7 @@ application restart, you can specify them with `Spring.watch`:
362362
Spring.watch "config/some_config_file.yml"
363363
```
364364

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

383383
The following environment variables are used by Spring:
384384

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

0 commit comments

Comments
 (0)