[Groonga-commit] ranguba/groonga-client at 24a53b4 [master] doc: update usages

Back to archive index

Kouhei Sutou null+****@clear*****
Thu Apr 27 11:43:18 JST 2017


Kouhei Sutou	2017-04-27 11:43:18 +0900 (Thu, 27 Apr 2017)

  New Revision: 24a53b40d859186d0c17fa023b305f57fc873065
  https://github.com/ranguba/groonga-client/commit/24a53b40d859186d0c17fa023b305f57fc873065

  Message:
    doc: update usages

  Modified files:
    lib/groonga/client/request/select.rb

  Modified: lib/groonga/client/request/select.rb (+6 -6)
===================================================================
--- lib/groonga/client/request/select.rb    2017-04-27 11:22:13 +0900 (92556c6)
+++ lib/groonga/client/request/select.rb    2017-04-27 11:43:18 +0900 (c5393a0)
@@ -52,7 +52,7 @@ module Groonga
         #
         # @example Multiple filters
         #    request.
-        #      filter("user", "alice").
+        #      filter(:user, "alice").
         #        # -> --filter 'user == "alice"'
         #      filter("tags @ %{tag}", tag: "Ruby")
         #        # -> --filter '(user == "alice") && (tags @ "Ruby")'
@@ -63,7 +63,7 @@ module Groonga
         # @overload filter(column_name, value)
         #   Adds a `#{column_name} == #{value}` condition.
         #
-        #   @param column_name [String, Symbol] The target column name.
+        #   @param column_name [Symbol] The target column name.
         #
         #   @param value [Object] The column value. It's escaped
         #     automatically.
@@ -90,17 +90,17 @@ module Groonga
         #
         #   @example Use in_values function
         #      request.
-        #        filter.in_values("tags", "tag1", "tag2")
+        #        filter.in_values(:tags, "tag1", "tag2")
         #          # -> --filter 'in_values(tags, "tag1", "tag2")'
         #
         #   @example Use geo_in_circle function
         #      request.
-        #        filter.geo_in_circle("0x0", "100x100", 300)
-        #          # -> --filter 'geo_in_circle("0x0", "100x100", 300, "rectangle")'
+        #        filter.geo_in_circle(:location, "100x100", 300)
+        #          # -> --filter 'geo_in_circle(location, "100x100", 300, "rectangle")'
         #
         #   @example Use between function
         #      request.
-        #        filter.between("age", 19, "include", 32, "include")
+        #        filter.between(:age, 19, "include", 32, "include")
         #          # -> --filter 'between(age, 19, "include", 32, "include")'
         #
         #   @return [Groonga::Client::Request::Select::Filter]
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index