Enhance API docs of portal.translate to show that the domain is optio… (

#510) Co-authored-by: Steve Piercy <web@stevepiercy.com>
plone · Jul 12, 2023 · 69a745d · 69a745d
1 parent 0beddf5
commit 69a745d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/news/510.documentation b/news/510.documentation
@@ -0,0 +1 @@
+Enhance API docs of `portal.translate` to show that the domain is optional in some cases. @thet
diff --git a/src/plone/api/portal.py b/src/plone/api/portal.py
@@ -408,7 +408,9 @@ def translate(msgid, domain="plone", lang=None):
 
     :param msgid: [required] message to translate
     :type msgid: string
-    :param domain: i18n domain to use
+    :type msgid: zope.i18nmessageid.Message
+    :param domain: i18n domain to use. When ``msgid`` is an instance of ``Message``,
+                   then the ``Message``'s domain is used.
     :type domain: string
     :param lang: target language
     :type lang: string