Skip to content

Commit 6ca3a2e

Browse files
committed
Edit pass over the CHANGELOG of Active Record
Adds missing punctuation, revises grammar, updates typography, etc. This follows our documentation guidelines, and makes the CHANGELOG consistent in style.
1 parent d429bfb commit 6ca3a2e

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

activerecord/CHANGELOG.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@
1414

1515
*Petrik de Heus*
1616

17-
* Validate using `:on` option when using `validates_associated`
18-
19-
Fixes an issue where `validates_associated` `:on` option wasn't respected
20-
when validated associated records.
17+
* Fixes an issue where `validates_associated` `:on` option wasn't respected
18+
when validating associated records.
2119
2220
*Austen Madden*, *Alex Ghiculescu*, *Rafał Brize*
2321
24-
* Allow overriding SQLite defaults from `database.yml`
22+
* Allow overriding SQLite defaults from `database.yml`.
2523
26-
Any PRAGMA configuration set under the `pragmas` key in the configuration file take precedence over Rails' defaults, and additional PRAGMAs can be set as well.
24+
Any PRAGMA configuration set under the `pragmas` key in the configuration
25+
file takes precedence over Rails' defaults, and additional PRAGMAs can be
26+
set as well.
2727

2828
```yaml
2929
database: storage/development.sqlite3
@@ -35,16 +35,16 @@
3535

3636
*Stephen Margheim*
3737

38-
* Remove warning message when running SQLite in production, but leave it unconfigured
38+
* Remove warning message when running SQLite in production, but leave it unconfigured.
3939

40-
There are valid use cases for running SQLite in production, however it must be done
40+
There are valid use cases for running SQLite in production. However it must be done
4141
with care, so instead of a warning most users won't see anyway, it's preferable to
4242
leave the configuration commented out to force them to think about having the database
4343
on a persistent volume etc.
4444

4545
*Jacopo Beschi*, *Jean Boussier*
4646

47-
* Add support for generated columns in SQLite3 adapter
47+
* Add support for generated columns to the SQLite3 adapter.
4848

4949
Generated columns (both stored and dynamic) are supported since version 3.31.0 of SQLite.
5050
This adds support for those to the SQLite3 adapter.
@@ -61,15 +61,15 @@
6161

6262
* TrilogyAdapter: ignore `host` if `socket` parameter is set.
6363

64-
This allows to configure a connection on a UNIX socket via DATABASE_URL:
64+
This allows to configure a connection on a UNIX socket via `DATABASE_URL`:
6565

6666
```
6767
DATABASE_URL=trilogy://does-not-matter/my_db_production?socket=/var/run/mysql.sock
6868
```
6969

7070
*Jean Boussier*
7171

72-
* Make `assert_queries_count`, `assert_no_queries`, `assert_queries_match` and
72+
* Make `assert_queries_count`, `assert_no_queries`, `assert_queries_match`, and
7373
`assert_no_queries_match` assertions public.
7474

7575
To assert the expected number of queries are made, Rails internally uses `assert_queries_count` and
@@ -114,7 +114,7 @@
114114

115115
*Kevin McPhillips*
116116

117-
* `DatabaseConfigurations#configs_for` can accept a symbol in the `name` parameter.
117+
* `DatabaseConfigurations#configs_for` accepts a symbol in the `name` parameter.
118118

119119
*Andrew Novoselac*
120120

@@ -140,32 +140,31 @@
140140
Post.first.inspect #=> "#<Post id: 1, title: "Hello, World!">"
141141
```
142142

143-
With the `attributes_for_inspect` set to `:all`, `inspect` will list all the record's attributes.
143+
With `attributes_for_inspect` set to `:all`, `inspect` will list all the record's attributes.
144144
145145
```ruby
146146
Post.attributes_for_inspect = :all
147147
Post.first.inspect #=> "#<Post id: 1, title: "Hello, World!", published_at: "2023-10-23 14:28:11 +0000">"
148148
```
149149
150-
In development and test mode, `attributes_for_inspect` will be set to `:all` by default.
150+
In `development` and `test` mode, `attributes_for_inspect` will be set to `:all` by default.
151151
152152
You can also call `full_inspect` to get an inspection with all the attributes.
153153
154154
The attributes in `attribute_for_inspect` will also be used for `pretty_print`.
155155
156156
*Andrew Novoselac*
157157
158-
* Don't mark Float::INFINITY as changed when reassigning it
159-
160-
When saving a record with a float infinite value, it shouldn't mark as changed
158+
* Don't mark attributes as changed when reassigned to `Float::INFINITY` or
159+
`-Float::INFINITY`.
161160

162161
*Maicol Bentancor*
163162

164-
* Support `RETURNING` clause for MariaDB
163+
* Support the `RETURNING` clause for MariaDB.
165164

166165
*fatkodima*, *Nikolay Kondratyev*
167166

168-
* The SQLite3 adapter now implements the `supports_deferrable_constraints?` contract
167+
* The SQLite3 adapter now implements the `supports_deferrable_constraints?` contract.
169168

170169
Allows foreign keys to be deferred by adding the `:deferrable` key to the `foreign_key` options.
171170

@@ -176,7 +175,7 @@
176175

177176
*Stephen Margheim*
178177

179-
* Add `set_constraints` helper for PostgreSQL
178+
* Add the `set_constraints` helper to PostgreSQL connections.
180179

181180
```ruby
182181
Post.create!(user_id: -1) # => ActiveRecord::InvalidForeignKey
@@ -192,7 +191,7 @@
192191

193192
*Cody Cutrer*
194193

195-
* Include `ActiveModel::API` in `ActiveRecord::Base`
194+
* Include `ActiveModel::API` in `ActiveRecord::Base`.
196195

197196
*Sean Doyle*
198197

0 commit comments

Comments
 (0)