[Groonga-commit] groonga/groonga at e177470 [master] doc table_create: improve structure

Back to archive index

Kouhei Sutou null+****@clear*****
Fri Oct 14 12:30:19 JST 2016


Kouhei Sutou	2016-10-14 12:30:19 +0900 (Fri, 14 Oct 2016)

  New Revision: e177470c8336ba21f4e8464af68c8b626815a990
  https://github.com/groonga/groonga/commit/e177470c8336ba21f4e8464af68c8b626815a990

  Message:
    doc table_create: improve structure

  Modified files:
    doc/locale/ja/LC_MESSAGES/reference.po
    doc/source/reference/commands/table_create.rst

  Modified: doc/locale/ja/LC_MESSAGES/reference.po (+1 -1)
===================================================================
--- doc/locale/ja/LC_MESSAGES/reference.po    2016-10-14 12:29:31 +0900 (c4ae676)
+++ doc/locale/ja/LC_MESSAGES/reference.po    2016-10-14 12:30:19 +0900 (102dc82)
@@ -12568,7 +12568,7 @@ msgstr ""
 "``normalizer`` オプションに ``NormalizerAuto`` を指定してください。"
 
 msgid ""
-"You must specify one of ``TABLE_${TYPE}`` flags. You cannot specify two or "
+"You must specify one of ``TABLE_${TYPE}`` flags. You can't specify two or "
 "more ``TABLE_${TYPE}`` flags. For example, ``TABLE_NO_KEY|TABLE_HASH_KEY`` "
 "is invalid."
 msgstr ""

  Modified: doc/source/reference/commands/table_create.rst (+19 -10)
===================================================================
--- doc/source/reference/commands/table_create.rst    2016-10-14 12:29:31 +0900 (f14945f)
+++ doc/source/reference/commands/table_create.rst    2016-10-14 12:30:19 +0900 (ec8a85a)
@@ -195,10 +195,15 @@ Parameters
 
 This section describes all parameters.
 
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is only one required parameter.
+
 .. _table-create-name:
 
 ``name``
-^^^^^^^^
+""""""""
 
 Specifies a table name to be created. ``name`` must be specified.
 
@@ -214,13 +219,17 @@ Here are available characters:
   character.)
 
 You need to create a name with one or more the above characters. Note
-that you cannot use ``_`` as the first character such as
-``_name``.
+that you can't use ``_`` as the first character such as ``_name``.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are some optional parameters.
 
 .. _table-create-flags:
 
 ``flags``
-^^^^^^^^^
+"""""""""
 
 Specifies a table type and table customize options.
 
@@ -249,7 +258,7 @@ Here are available flags:
    Since Groonga 2.1.0 ``KEY_NORMALIZE`` flag is deprecated. Use
    ``normalizer`` option with ``NormalizerAuto`` instead.
 
-You must specify one of ``TABLE_${TYPE}`` flags. You cannot specify two
+You must specify one of ``TABLE_${TYPE}`` flags. You can't specify two
 or more ``TABLE_${TYPE}`` flags. For example,
 ``TABLE_NO_KEY|TABLE_HASH_KEY`` is invalid.
 
@@ -263,7 +272,7 @@ The default flags are ``TABLE_HASH_KEY``.
 .. _table-create-key-type:
 
 ``key_type``
-^^^^^^^^^^^^
+""""""""""""
 
 Specifies key type.
 
@@ -278,7 +287,7 @@ The default value is none.
 .. _table-create-value-type:
 
 ``value_type``
-^^^^^^^^^^^^^^
+""""""""""""""
 
 Specifies value type.
 
@@ -292,7 +301,7 @@ The default value is none.
 .. _table-create-default-tokenizer:
 
 ``default_tokenizer``
-^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""
 
 Specifies the default tokenizer that is used on searching and data
 loading.
@@ -325,7 +334,7 @@ The default value is none.
 .. _table-create-normalizer:
 
 ``normalizer``
-^^^^^^^^^^^^^^
+""""""""""""""
 
 Specifies a normalizer that is used to normalize key.
 
@@ -339,7 +348,7 @@ The default value is none.
 .. _table-create-token-filters:
 
 ``token_filters``
-^^^^^^^^^^^^^^^^^^
+"""""""""""""""""
 
 Specifies token filters that is used to some processes tokenized token.
 
-------------- next part --------------
HTML����������������������������...
Download 



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