Skip to content

Commit

Permalink
Fix documents of geo_in_rectangle.
Browse files Browse the repository at this point in the history
  • Loading branch information
komainu8 committed Apr 27, 2017
1 parent ab7cee7 commit 6da5a49
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions lib/groonga/client/request/select.rb
Original file line number Diff line number Diff line change
Expand Up @@ -229,21 +229,39 @@ def initialize(request)
# @see http://groonga.org/docs/reference/functions/geo_in_rectangle.html
# geo_in_rectangle function in the Groonga document
#
# @example: Basic usage
# request.
# filter.geo_in_rectangle(:location, "0x100", "100x0").
# # -> --filter 'in_values(location, 0x100, 100x0)'
# @overload geo_in_rectangle(column_name, top_left, bottom_right)
#
# @param column_name [Symbol] The column name to be checked.
# @example: Basic usage
# request.
# filter.geo_in_rectangle(:location, "0x100", "100x0").
# # -> --filter 'geo_in_rectangle(location, 0x100, 100x0)'
#
# @param top_left [String] The top left of the condition rectangle.
# `"#{LONGITUDE}x#{LATITUDE}"` is the point format.
# @param column_name [Symbol] The column name to be checked.
#
# @param bottom_right [String] The bottom right of the condition rectangle.
# `"#{LONGITUDE}x#{LATITUDE}"` is the point format.
# @!macro [new] geo_in_rectangle
#
# @return [Groonga::Client::Request::Select]
# The new request with the given condition.
# @param top_left [String] The top left of the condition rectangle.
# `"#{LONGITUDE}x#{LATITUDE}"` is the point format.
#
# @param bottom_right [String] The bottom right of the condition rectangle.
# `"#{LONGITUDE}x#{LATITUDE}"` is the point format.
#
# @return [Groonga::Client::Request::Select]
# The new request with the given condition.
#
# @macro geo_in_rectangle
#
# @overload geo_in_rectangle(point, top_left, bottom_right)
#
# @example Basic usage
# request.
# filter.geo_in_rectangle("50x50", "0x100", "100x0").
# # -> --filter 'geo_in_rectangle("50x50", "0x100", "100x0")'
#
# @param point [String] The point to be checked.
# `"#{LONGITUDE}x#{LATITUDE}"` is the point format.
#
# @macro geo_in_rectangle
#
# @since 0.5.0
def geo_in_rectangle(column_name_or_point,
Expand Down

0 comments on commit 6da5a49

Please sign in to comment.