From 9b031bd2ad5204201d467253ad8775d606d3f9b3 Mon Sep 17 00:00:00 2001
From: Vincent Pelletier <vincent@nexedi.com>
Date: Sun, 11 Jun 2017 09:24:47 +0900
Subject: [PATCH] ERP5Catalog: Document dynamic related key name syntax

---
 product/ERP5Catalog/CatalogTool.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/product/ERP5Catalog/CatalogTool.py b/product/ERP5Catalog/CatalogTool.py
index 2875f2e0da..f8cf03b0b9 100644
--- a/product/ERP5Catalog/CatalogTool.py
+++ b/product/ERP5Catalog/CatalogTool.py
@@ -955,6 +955,15 @@ class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
 
       strict_ related keys only returns documents which are strictly member of
       the category.
+
+      Syntax:
+        [default_][strict_][parent_]<base category id>[related_]<column id>
+      "default_": No effect, useful to avoid static related keys, which would shadow desired dynamic related key.
+      "strict_": Match only strict relation members, otherwise match non-strict too.
+      "parent_": Search for documents whose parent have described relation, otherwise search for their immediate relations.
+      <base_category_id>: The id of an existing Base Category document.
+      "related_": Search for reverse relationships, otherwise search for direct relationships.
+      <column_id>: The name of the column to compare values against.
       """
       related_key_list = []
       base_cat_id_set = set(
-- 
2.30.9