Skip to content

Add options usage notes to README. #316

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
merged 1 commit into from
Feb 5, 2019
Merged

Add options usage notes to README. #316

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

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,8 @@ class ExampleEntity < Grape::Entity
end
```

You have always access to the presented instance with `object`
You always have access to the presented instance (`object`) and the top-level
entity options (`options`).

```ruby
class ExampleEntity < Grape::Entity
Expand All @@ -229,7 +230,7 @@ class ExampleEntity < Grape::Entity
private

def formatted_value
"+ X #{object.value}"
"+ X #{object.value} #{options[:y]}"
end
end
```
Expand Down