Kouhei Sutou
kou****@clear*****
Tue Jul 28 13:16:51 JST 2015
コメントにしないで成果物の中で見えるようにしてください。 ユーザーも含めて誰にでも見えるようにしておかないと開発者も忘 れてしまいます。 In <48ff9be9875d03005d6760116a8ee9c512f9b262 �� jenkins.clear-code.com> "[Groonga-commit] groonga/groonga �� 48ff9be [master] doc logical_range_filter: add TODO comments" on Tue, 28 Jul 2015 13:08:18 +0900, Masafumi Yokoyama <null+groonga �� clear-code.com> wrote: > Masafumi Yokoyama 2015-07-28 13:08:18 +0900 (Tue, 28 Jul 2015) > > New Revision: 48ff9be9875d03005d6760116a8ee9c512f9b262 > https://github.com/groonga/groonga/commit/48ff9be9875d03005d6760116a8ee9c512f9b262 > > Message: > doc logical_range_filter: add TODO comments > > Modified files: > doc/source/reference/commands/logical_range_filter.rst > > Modified: doc/source/reference/commands/logical_range_filter.rst (+24 -0) > =================================================================== > --- doc/source/reference/commands/logical_range_filter.rst 2015-07-28 13:00:28 +0900 (715acc5) > +++ doc/source/reference/commands/logical_range_filter.rst 2015-07-28 13:08:18 +0900 (9339a6d) > @@ -45,6 +45,8 @@ Register ``sharding`` plugin to use ``logical_range_filter`` command in advance. > .. groonga-command > .. register sharding > > +.. TODO: Add examples > + > Parameters > ---------- > > @@ -61,11 +63,15 @@ There are required parameters, ``logical_table`` and ``shard_key``. > Specifies logical table name. It means table name without "_YYYYMMDD" postfix. > If you use actual table such as "Logs_20150203", "Logs_20150203" and so on, logical table name is "Logs". > > +.. TODO: Add examples > + > ``shard_key`` > """"""""""""" > > Specifies column name which is treated as shared key in each parted table. > > +.. TODO: Add examples > + > Optional parameters > ^^^^^^^^^^^^^^^^^^^ > > @@ -76,41 +82,59 @@ There are optional parameters. > > Specifies the min value of ``shard_key`` > > +.. TODO: Add examples > + > ``min_border`` > """""""""""""" > > Specifies whether the min value of borderline must be include or not. > Specify ``include`` or ``exclude`` as the value of this parameter. > > +.. TODO: Add examples > + > ``max`` > """"""" > > Specifies the max value of ``shard_key``. > > +.. TODO: Add examples > + > ``max_border`` > """""""""""""" > > Specifies whether the max value of borderline must be include or not. > Specify ``include`` or ``exclude`` as the value of this parameter. > > +.. TODO: Add examples > + > ``order`` > """""""""" > > +.. TODO > + > ``filter`` > """""""""" > > +.. TODO > + > ``offset`` > """""""""" > > +.. TODO > + > ``output_columns`` > """""""""""""""""" > > +.. TODO > + > ``use_range_index`` > """"""""""""""""""" > > Specifies whether range_index is used or not. > Note that it's a parameter for test. It should not be used for production. > > +.. TODO: Add examples > + > Return value > ------------ >