Kouhei Sutou
null+****@clear*****
Thu Apr 13 13:34:57 JST 2017
Kouhei Sutou 2017-04-13 13:34:57 +0900 (Thu, 13 Apr 2017) New Revision: 38798792c10da55020c848d522c6279a549b34e9 https://github.com/ranguba/groonga-client/commit/38798792c10da55020c848d522c6279a549b34e9 Message: doc: put summary before parameters Modified files: lib/groonga/client/request/select.rb Modified: lib/groonga/client/request/select.rb (+11 -7) =================================================================== --- lib/groonga/client/request/select.rb 2017-04-13 13:33:28 +0900 (47a69c7) +++ lib/groonga/client/request/select.rb 2017-04-13 13:34:57 +0900 (683dcd8) @@ -61,15 +61,21 @@ module Groonga # The new request with the given condition. # # @overload filter(column_name, value) + # Adds a `#{column_name} == #{value}` condition. + # # @param column_name [String, Symbol] The target column name. - # @param value [Object] The column value. It's escaped automatically. # - # Adds a `#{column_name} == #{value}` condition. + # @param value [Object] The column value. It's escaped + # automatically. # # @overload filter(expression, values=nil) + # + # Adds a `#{expression % values}` condition. + # # @param expression [String] The script syntax expression. # It can includes `%{name}`s as placeholder. They are expanded # by `String#%` with the given `values` argument. + # # @param values [nil, ::Hash] The values to be expanded. # If the given `expression` doesn't have placeholder, you # should specify `nil`. @@ -77,18 +83,16 @@ module Groonga # Values are escaped automatically. Values passed from # external should be escaped. # - # Adds a `#{expression % values}` condition. - # # @overload filter # + # Returns a request object for filter condition. It provides + # convenient methods to add a popular filter condition. + # # @example: Use in_values function # request. # filter.in_values("tags", "tag1", "tag2") # # -> --filter 'in_values(tags, "tag1", "tag2")' # - # Returns a request object for filter condition. It provides - # convenient methods to add a popular filter condition. - # # @return [Groonga::Client::Request::Select::Filter] # The new request object for setting a filter condition. # -------------- next part -------------- HTML����������������������������...Download