Skip to content

Fix a few typos in Readme #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafaelfranca merged 1 commit into from
May 29, 2024
Merged

Fix a few typos in Readme #180

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ GlobalID::Locator.locate_signed person_sgid

**Expiration**

Signed Global IDs can expire some time in the future. This is useful if there's a resource
Signed Global IDs can expire sometime in the future. This is useful if there's a resource
Copy link
Member

@rafaelfranca rafaelfranca May 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Signed Global IDs can expire sometime in the future. This is useful if there's a resource
Signed Global IDs can expire some time in the future. This is useful if there's a resource

Copy link
Contributor Author

@duffuniverse duffuniverse May 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @rafaelfranca
Grammarly suggested to fix this. See description
Screenshot from 2024-05-30 00-29-04
Do you want me to commit your suggestion instead?

people shouldn't have indefinite access to, like a share link.

```ruby
Expand Down Expand Up @@ -87,7 +87,7 @@ You can assign a default SGID lifetime like so:
SignedGlobalID.expires_in = 1.month
```

This way any generated SGID will use that relative expiry.
This way, any generated SGID will use that relative expiry.

It's worth noting that _expiring SGIDs are not idempotent_ because they encode the current timestamp; repeated calls to `to_sgid` will produce different results. For example, in Rails

Expand Down Expand Up @@ -169,12 +169,12 @@ Either `GlobalID::Locator.locate` or `GlobalID::Locator.locate_many` supports a
The same structure you would pass into a `includes` method of Active Record.
See [Active Record eager loading associations](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations)
If present, `locate` or `locate_many` will eager load all the relationships specified here.
Note: It only works if all the gids models have that relationships.
Note: It only works if all the gids models have those relationships.
* :only - A class, module or Array of classes and/or modules that are
allowed to be located. Passing one or more classes limits instances of returned
classes to those classes or their subclasses. Passing one or more modules in limits
instances of returned classes to those including that module. If no classes or
modules match, +nil+ is returned.
modules match, `nil` is returned.
* :ignore_missing (Only for `locate_many`) - By default, `locate_many` will call `#find` on the model to locate the
ids extracted from the GIDs. In Active Record (and other data stores following the same pattern),
`#find` will raise an exception if a named ID can't be found. When you set this option to true,
Expand Down