Skip to content
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.

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

Fix typos #64

Merged
merged 4 commits into from
Feb 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/docs/associations.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Panko::ArraySerializer.new(posts, only: {
})
```

Let's disect `only` option we passed -
Let's dissect `only` option we passed -
* `instance` - list of attributes (and associations) we want to serializer for current instance of the serializer, in this case - `PostSerializer`.
* `author`, `comments` - here we specify the list of attributes we want to serialize for each association.

Expand All @@ -91,4 +91,4 @@ Panko::ArraySerializer.new(posts, only: {
})
```

As you see now in `comments` the `instance` have differenet meaning, the `CommentSerializer`.
As you see now in `comments` the `instance` have different meaning, the `CommentSerializer`.
4 changes: 2 additions & 2 deletions docs/docs/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ UserSerializer.new(except: [:name]).serialize(User.first)
> property is not taken into account.
> If you have a `has_many :state_transitions, name: :history` association
> defined, the key to use in filters is `:state_transitions`
> (e.g. `{ except: [:state_statitions] }`)
> (e.g. `{ except: [:state_transitions] }`)

## Filters For

Expand All @@ -110,7 +110,7 @@ end
UserSerializer.serialize(User.first)
```

> See disucssion in: https://github.com/yosiat/panko_serializer/issues/16
> See discussion in: https://github.com/yosiat/panko_serializer/issues/16

## Aliases

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/design-choices.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ And the usage of this serializer will be:
user = User.first

# create serializer, with empty options
serializer = UserSerilizer.new
serializer = UserSerializer.new

# serialize to JSON
serializer.serialize_to_json(user)
Expand Down