Skip to content

Commit f6cee94

Browse files
authored
Merge pull request #173 from stevenharman/typos_and_formatting
Fix a typo and normalize formatting
2 parents fefee2d + b765497 commit f6cee94

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ GlobalID::Locator.locate_signed(expiring_sgid.to_s, for: 'sharing')
7373
# => nil
7474
```
7575

76-
**In Rails, an auto-expiry of 1 month is set by default.** You can alter that deal
77-
in an initializer with:
76+
**In Rails, an auto-expiry of 1 month is set by default.** You can alter that
77+
default in an initializer with:
7878

7979
```ruby
8080
# config/initializers/global_id.rb
@@ -165,19 +165,19 @@ Note the order is maintained in the returned results.
165165

166166
Either `GlobalID::Locator.locate` or `GlobalID::Locator.locate_many` supports a hash of options as second parameter. The supported options are:
167167

168-
* :includes - A Symbol, Array, Hash or combination of them
169-
The same structure you would pass into a `includes` method of Active Record.
170-
See [Active Record eager loading associations](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations)
168+
* `:includes` - A Symbol, Array, Hash or combination of them.
169+
The same structure you would pass into an `includes` method of Active Record.
170+
See [Active Record eager loading associations](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations).
171171
If present, `locate` or `locate_many` will eager load all the relationships specified here.
172-
Note: It only works if all the gids models have those relationships.
173-
* :only - A class, module or Array of classes and/or modules that are
172+
Note: It only works if all the GIDs Models have those relationships.
173+
* `:only` - A class, module, or Array of classes and/or modules that are
174174
allowed to be located. Passing one or more classes limits instances of returned
175175
classes to those classes or their subclasses. Passing one or more modules in limits
176176
instances of returned classes to those including that module. If no classes or
177177
modules match, `nil` is returned.
178-
* :ignore_missing (Only for `locate_many`) - By default, `locate_many` will call `#find` on the model to locate the
178+
* `:ignore_missing` (Only for `locate_many`) - By default, `locate_many` will call `#find` on the model to locate the
179179
ids extracted from the GIDs. In Active Record (and other data stores following the same pattern),
180-
`#find` will raise an exception if a named ID can't be found. When you set this option to true,
180+
`#find` will raise an exception if a named ID can't be found. When you set this option to `true`,
181181
we will use `#where(id: ids)` instead, which does not raise on missing records.
182182

183183
### Custom App Locator
@@ -207,7 +207,7 @@ class BarLocator
207207
end
208208
```
209209

210-
After defining locators as above, URIs like "gid://foo/Person/1" and "gid://bar/Person/1" will now use the foo block locator and `BarLocator` respectively.
210+
After defining locators as above, URIs like `gid://foo/Person/1` and `gid://bar/Person/1` will now use the foo block locator and `BarLocator` respectively.
211211
Other apps will still keep using the default locator.
212212

213213
## Contributing to GlobalID

0 commit comments

Comments
 (0)