doc reference: add a document for the escalate() function #1429

komainu8 · 2022-10-12T08:33:51Z

No description provided.

komainu8 · 2022-10-12T09:06:06Z

@kou @HashidaTKS Could you review this PR?
@yoshimotoyuk Could you review about English?

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

yoshimotoyuk · 2022-10-12T10:20:45Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+"方法はオーバヘッドが大きい方法です。"
+
+msgid ""
+"However, ``escalte`` is for any full text search by inverted index. "


44行目と49行目が同じ意味には取れないです。
複数のindexに対応することが逆引き検索という事になるのであれば大丈夫だと思います。
数が複数の逆引き全文検索をまとめてできるということならmultiple full text searchだと思います。

「数が複数の逆引き全文検索をまとめてできる」ということを言いたいのでmultiple full text searchに変更します。

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

doc/source/reference/functions/escalate.rst

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

yoshimotoyuk · 2022-10-13T01:58:00Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+msgstr "``escalate`` は一つ以上の引数を持ちます::"
+
+msgid ""
+"``CONDITION_N`` and ``THRESHOLD_N`` are pair. However, the last condition "


もしlast conditionが最後の引数条件という意味なら、英語的には parameter入れておいた方が分かりやすい気がします。

↑のコメント受けて、 last condition と書くのがわかりにくい気がしたので、 CONDITION_ みたいに引数名を直接書くようにしました。

doc/source/reference/functions/escalate.rst

yoshimotoyuk · 2022-10-13T02:06:01Z

This is a memo.... for future
Generally 「条件」 translate to condition in those documents. and It is correct but it may be more explainable to choose different words.
Like....
検索条件：search criteria
必要条件（動作させるのに必須な条件）: requirement
制限条件（資格など必要条件）:　qualification
ref) https://www.linkedin.com/pulse/construction-general-conditions-vs-requirements-fullcircleconsulting

komainu8 · 2022-10-13T03:29:24Z

一通り修正しました。

doc/source/reference/functions/escalate.rst

HashidaTKS · 2022-10-13T04:16:23Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+msgstr "戻り値"
+
+msgid "``escalate`` returns whether a record is matched or not as boolean."
+msgstr "``escalte`` は対象レコードがマッチしたかどうかを真偽値で返します。"


Suggested change

msgstr "``escalte`` は対象レコードがマッチしたかどうかを真偽値で返します。"

msgstr "``escalate`` は対象レコードがマッチしたかどうかを真偽値で返します。"

HashidaTKS · 2022-10-13T04:16:52Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+"of results that we search with ``CONDITION_N`` in more than ``THRESHOLD_N``, "
+"``escalate`` doesn't evaluate next condition."
+msgstr ""
+"``CONDITION_N`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalte`` は"


Suggested change

"``CONDITION_N`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalte`` は"

"``CONDITION_N`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalate`` は"

HashidaTKS · 2022-10-13T04:17:22Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+"方法はオーバヘッドが大きい方法です。"
+
+msgid ""
+"However, ``escalte`` is for multiple full text search by inverted index. "


Suggested change

"However, ``escalte`` is for multiple full text search by inverted index. "

"However, ``escalate`` is for multiple full text search by inverted index. "

HashidaTKS · 2022-10-13T04:17:31Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+msgstr ""
+"しかし、 ``escalate`` は複数のインデックスにも対応しています。そのため、厳密"
+"に検索するインデックスを使った検索とゆるく検索するインデックスを使った検索を"
+"一つのクエリーで実行できます。``escalte`` を使うことによって、オーバーヘッド"


Suggested change

"一つのクエリーで実行できます。``escalte`` を使うことによって、オーバーヘッド"

"一つのクエリーで実行できます。``escalate`` を使うことによって、オーバーヘッド"

HashidaTKS · 2022-10-13T04:17:55Z

doc/source/reference/functions/escalate.rst

+Therefore, for example, if we can't get record in a search with a index that execute search strictly, we need to search with a index that execute search loosely once again.
+This procedure has many overhead.
+
+However, ``escalte`` is for multiple full text search by inverted index.


Suggested change

However, ``escalte`` is for multiple full text search by inverted index.

However, ``escalate`` is for multiple full text search by inverted index.

HashidaTKS · 2022-10-13T04:20:22Z

typo修正系のcommitが消えてしまっているように見えるのですが、確認頂けないでしょうか？

Co-authored-by: Takashi Hashida <hashida@clear-code.com>

HashidaTKS · 2022-10-13T05:01:30Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+
+msgid ""
+"A condition that we specify ``CONDITION_1`` is always executed. Therefore, "
+"``CONDITION_1`` has not a threshold as pair."


Suggested change

"``CONDITION_1`` has not a threshold as pair."

"``CONDITION_1`` doesn't have a threshold as pair."

HashidaTKS · 2022-10-13T05:01:55Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+
+msgid ""
+"``THRESHOLD_N`` is optional. However, when ``CONDITION_N`` exist "
+"``THRESHOLD_N`` is required. (However, ``CONDITION_1`` has not a threshold "


Suggested change

"``THRESHOLD_N`` is required. (However, ``CONDITION_1`` has not a threshold "

"``THRESHOLD_N`` is required. (However, ``CONDITION_1`` doesn't have a threshold "

HashidaTKS · 2022-10-13T05:02:13Z

doc/source/reference/functions/escalate.rst

+             THRESHOLD_N, CONDITION_N)
+
+``CONDITION_N`` and ``THRESHOLD_N`` are pair.
+However, ``CONDITION_1`` has not a threshold as pair. Because this condition is always executed.


Suggested change

However, ``CONDITION_1`` has not a threshold as pair. Because this condition is always executed.

However, ``CONDITION_1`` doesn't have a threshold as pair. Because this condition is always executed.

HashidaTKS · 2022-10-13T05:02:28Z

doc/source/reference/functions/escalate.rst

+``THRESHOLD_N``
+~~~~~~~~~~~~~~~
+
+``THRESHOLD_N`` is optional. However, when ``CONDITION_N`` exists ``THRESHOLD_N`` is required. (However, ``CONDITION_1`` has not a threshold as pair.)


Suggested change

``THRESHOLD_N`` is optional. However, when ``CONDITION_N`` exists ``THRESHOLD_N`` is required. (However, ``CONDITION_1`` has not a threshold as pair.)

``THRESHOLD_N`` is optional. However, when ``CONDITION_N`` exists ``THRESHOLD_N`` is required. (However, ``CONDITION_1`` doesn't have a threshold as pair.)

HashidaTKS · 2022-10-13T05:02:56Z

doc/source/reference/functions/escalate.rst

+``CONDITION_1`` is required.
+
+A condition that we specify ``CONDITION_1`` is always executed.
+Therefore, ``CONDITION_1`` has not a threshold as pair.


Suggested change

Therefore, ``CONDITION_1`` has not a threshold as pair.

Therefore, ``CONDITION_1`` doesn't have a threshold as pair.

Co-authored-by: Takashi Hashida <hashida@clear-code.com>

komainu8 · 2022-10-13T05:35:30Z

typo修正系のcommitが消えてしまっているように見えるのですが、確認頂けないでしょうか？

すみません。上書きしてしまったみたいです。

追加の指摘も修正しました。

HashidaTKS · 2022-10-14T01:08:11Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+"り大きい場合、 ``escalate`` は次の条件を評価しません。"
+
+msgid "``THRESHOLD_N`` is a positive number such 0 and 29."
+msgstr "``THRESHOLD_N`` は 0 や 29 のような正の数です。"


細かい話なのですが、0は正の数ではないので、「正の数」ではなく「0以上の数値」が正しそうに思いました。

０以上の整数としました。

HashidaTKS · 2022-10-14T01:09:45Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+"``THRESHOLD_N``, ``escalate`` doesn't evaluate ``CONDITION_N``."
+msgstr ""
+"``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalate`` "
+"は次の条件を評価します。``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` よ"


Suggested change

"は次の条件を評価します。``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` よ"

"は ``CONDITION_N`` を評価します。``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` よ"

↑の通り修正しました。

HashidaTKS · 2022-10-14T01:09:58Z

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po

+msgstr ""
+"``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalate`` "
+"は次の条件を評価します。``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` よ"
+"り大きい場合、 ``escalate`` は次の条件を評価しません。"


Suggested change

"り大きい場合、 ``escalate`` は次の条件を評価しません。"

"り大きい場合、 ``escalate`` は ``CONDITION_N`` を評価しません。"

↑の通り修正しました。

komainu8 · 2022-10-14T01:35:37Z

追加の指摘を修正しました。

HashidaTKS · 2022-10-14T03:05:18Z

ご対応ありがとうございます。私からは以上となります。

+1

komainu8 marked this pull request as ready for review October 12, 2022 09:03

yoshimotoyuk reviewed Oct 12, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Outdated Show resolved Hide resolved

yoshimotoyuk reviewed Oct 12, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Outdated Show resolved Hide resolved

yoshimotoyuk reviewed Oct 12, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/source/reference/functions/escalate.rst Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/source/reference/functions/escalate.rst Outdated Show resolved Hide resolved

yoshimotoyuk reviewed Oct 13, 2022

View reviewed changes

doc/locale/ja/LC_MESSAGES/reference/functions/escalate.po Outdated Show resolved Hide resolved

yoshimotoyuk reviewed Oct 13, 2022

View reviewed changes

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/source/reference/functions/escalate.rst Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/source/reference/functions/escalate.rst Outdated Show resolved Hide resolved

komainu8 added 7 commits October 13, 2022 11:56

doc reference: add a document for the escalate() function

db7fab7

Fix indent

b76f4fb

Translate to Japanese

395b180

Fix wrong English

3dce21b

Use code-block

f481a20

Translate to Japanese

903d5d0

Use more suitable example

3ec7e8b

komainu8 force-pushed the add-a-document-for-escalate branch from 43402ef to 3ec7e8b Compare October 13, 2022 02:56

Add a description about match escalation

28885c3

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/source/reference/functions/escalate.rst Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

doc/source/reference/functions/escalate.rst Outdated Show resolved Hide resolved

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

komainu8 and others added 6 commits October 13, 2022 13:45

Fix wrong English

d488182

Use more suitable English

d9377ca

Fix wrong English

25a54ad

Use more suitable English

70d172e

Fix typos

08afc96

Fix wrong explanation

aae539b

Co-authored-by: Takashi Hashida <hashida@clear-code.com>

HashidaTKS reviewed Oct 13, 2022

View reviewed changes

komainu8 and others added 4 commits October 13, 2022 14:05

Translate to Japanese

aed9032

Fix wrong explanation

aebf51d

Co-authored-by: Takashi Hashida <hashida@clear-code.com>

Fix typos

9312b74

Fix wrong English

e30865a

HashidaTKS reviewed Oct 14, 2022

View reviewed changes

komainu8 added 2 commits October 14, 2022 10:25

Fix wrong explanation

b5d85b4

Add missing translation

8150b22

komainu8 merged commit 5549ad1 into master Oct 14, 2022

komainu8 deleted the add-a-document-for-escalate branch October 14, 2022 06:33

github-actions bot mentioned this pull request May 22, 2023

nginx: update bundles version 1.23.4 komainu8/groonga#1

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc reference: add a document for the escalate() function #1429

doc reference: add a document for the escalate() function #1429

komainu8 commented Oct 12, 2022 •

edited

Loading

komainu8 commented Oct 12, 2022

yoshimotoyuk Oct 12, 2022

komainu8 Oct 13, 2022

yoshimotoyuk Oct 13, 2022

komainu8 Oct 13, 2022

yoshimotoyuk commented Oct 13, 2022

komainu8 commented Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS commented Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

HashidaTKS Oct 13, 2022

komainu8 commented Oct 13, 2022 •

edited

Loading

HashidaTKS Oct 14, 2022 •

edited

Loading

komainu8 Oct 14, 2022

HashidaTKS Oct 14, 2022

komainu8 Oct 14, 2022

HashidaTKS Oct 14, 2022

komainu8 Oct 14, 2022

komainu8 commented Oct 14, 2022

HashidaTKS commented Oct 14, 2022

	msgstr "``escalte`` は対象レコードがマッチしたかどうかを真偽値で返します。"
	msgstr "``escalate`` は対象レコードがマッチしたかどうかを真偽値で返します。"

	"``CONDITION_N`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalte`` は"
	"``CONDITION_N`` で検索した結果が ``THRESHOLD_N`` 以下の場合、 ``escalate`` は"

	"However, ``escalte`` is for multiple full text search by inverted index. "
	"However, ``escalate`` is for multiple full text search by inverted index. "

	"一つのクエリーで実行できます。``escalte`` を使うことによって、オーバーヘッド"
	"一つのクエリーで実行できます。``escalate`` を使うことによって、オーバーヘッド"

	However, ``escalte`` is for multiple full text search by inverted index.
	However, ``escalate`` is for multiple full text search by inverted index.

	"``CONDITION_1`` has not a threshold as pair."
	"``CONDITION_1`` doesn't have a threshold as pair."

	"``THRESHOLD_N`` is required. (However, ``CONDITION_1`` has not a threshold "
	"``THRESHOLD_N`` is required. (However, ``CONDITION_1`` doesn't have a threshold "

	However, ``CONDITION_1`` has not a threshold as pair. Because this condition is always executed.
	However, ``CONDITION_1`` doesn't have a threshold as pair. Because this condition is always executed.

	``THRESHOLD_N`` is optional. However, when ``CONDITION_N`` exists ``THRESHOLD_N`` is required. (However, ``CONDITION_1`` has not a threshold as pair.)
	``THRESHOLD_N`` is optional. However, when ``CONDITION_N`` exists ``THRESHOLD_N`` is required. (However, ``CONDITION_1`` doesn't have a threshold as pair.)

	Therefore, ``CONDITION_1`` has not a threshold as pair.
	Therefore, ``CONDITION_1`` doesn't have a threshold as pair.

	"は次の条件を評価します。``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` よ"
	"は ``CONDITION_N`` を評価します。``CONDITION_N-1`` で検索した結果が ``THRESHOLD_N`` よ"

	"り大きい場合、 ``escalate`` は次の条件を評価しません。"
	"り大きい場合、 ``escalate`` は ``CONDITION_N`` を評価しません。"

doc reference: add a document for the escalate() function #1429

doc reference: add a document for the escalate() function #1429

Conversation

komainu8 commented Oct 12, 2022 • edited Loading

komainu8 commented Oct 12, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yoshimotoyuk commented Oct 13, 2022

komainu8 commented Oct 13, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HashidaTKS commented Oct 13, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

komainu8 commented Oct 13, 2022 • edited Loading

HashidaTKS Oct 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

komainu8 commented Oct 14, 2022

HashidaTKS commented Oct 14, 2022

komainu8 commented Oct 12, 2022 •

edited

Loading

komainu8 commented Oct 13, 2022 •

edited

Loading

HashidaTKS Oct 14, 2022 •

edited

Loading