Added note about argument error

Andrew Kane
1 parent 6f298a9e
Showing 1 changed file with 2 additions and 0 deletions Show diff stats
README.md
@@ -151,6 +151,8 @@ Limit groupings with the `permit` option.
 User.group_by_period(params[:period], :created_at, permit: %w[day week]).count
 ```
  
+Raises an `ArgumentError` for unpermitted periods.
+
 ## Arrays and Hashes
  
 ```ruby
...	...	@@ -151,6 +151,8 @@ Limit groupings with the `permit` option.
151	151	User.group_by_period(params[:period], :created_at, permit: %w[day week]).count
152	152	```
153	153
	154	+Raises an `ArgumentError` for unpermitted periods.
	155	+
154	156	## Arrays and Hashes
155	157
156	158	```ruby
...	...