[doc-en] master: enchant: document the ValueError of the two dict_path functions (#6077)
| From: | Alejandro Borrego via GitHub | Date: | Sat, 14 Nov 2026 17:49:11 +0000 |
| Subject: | [doc-en] master: enchant: document the ValueError of the two dict_path functions (#6077) | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-23955@lists.php.net to get a copy of this message | ||
Author: Alejandro Borrego (abp002)
Committer: GitHub (web-flow)
Pusher: lacatoire
Date: 2026-11-14T18:49:08+01:00
Commit: https://github.com/php/doc-en/commit/b5f0a56490ca4a96b3aa35445d16024f545d01e2
Raw diff: https://github.com/php/doc-en/commit/b5f0a56490ca4a96b3aa35445d16024f545d01e2.diff
enchant: document the ValueError of the two dict_path functions (#6077)
Co-authored-by: Alejandro Borrego <210245044+abp002@users.noreply.github.com>
Changed paths:
M reference/enchant/functions/enchant-broker-get-dict-path.xml
M reference/enchant/functions/enchant-broker-set-dict-path.xml
Diff:
diff --git a/reference/enchant/functions/enchant-broker-get-dict-path.xml
b/reference/enchant/functions/enchant-broker-get-dict-path.xml
index 3e6a1de36f31..f31ac002636d 100644
--- a/reference/enchant/functions/enchant-broker-get-dict-path.xml
+++ b/reference/enchant/functions/enchant-broker-get-dict-path.xml
@@ -47,6 +47,17 @@
</simpara>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simpara>
+ Throws a <exceptionname>ValueError</exceptionname> if
+ <parameter>broker</parameter> is not usable, for example if it is
+ uninitialized or was already freed with
+ <function>enchant_broker_free</function>.
+ This only happens if the extension has been compiled with Enchant v1.
+ </simpara>
+ </refsect1>
+
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
diff --git a/reference/enchant/functions/enchant-broker-set-dict-path.xml
b/reference/enchant/functions/enchant-broker-set-dict-path.xml
index acf22f2d0349..0a0da3412738 100644
--- a/reference/enchant/functions/enchant-broker-set-dict-path.xml
+++ b/reference/enchant/functions/enchant-broker-set-dict-path.xml
@@ -55,6 +55,17 @@
</simpara>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simpara>
+ Throws a <exceptionname>ValueError</exceptionname> if
+ <parameter>broker</parameter> is not usable, for example if it is
+ uninitialized or was already freed with
+ <function>enchant_broker_free</function>.
+ This only happens if the extension has been compiled with Enchant v1.
+ </simpara>
+ </refsect1>
+
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>