Skip to content

Update strpos docs with error handling details when offset exceeds length #4959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimWolla merged 12 commits into from
Oct 28, 2025
Merged

Update strpos docs with error handling details when offset exceeds length #4959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e968761
Update strpos.xml with error handling details
beryllium Oct 27, 2025
360f39a
Document error for offset exceeding haystack length
beryllium Oct 27, 2025
4fca8b8
Merge pull request #1 from beryllium/patch-3
beryllium Oct 27, 2025
3d0cae1
Document error for exceeding offset length
beryllium Oct 27, 2025
c5bcf28
Merge pull request #2 from beryllium/patch-3
beryllium Oct 27, 2025
f5e04a5
Document error for offset exceeding haystack length
beryllium Oct 27, 2025
12e648f
Merge pull request #3 from beryllium/patch-3
beryllium Oct 27, 2025
99c9251
Apply suggestions from code review
beryllium Oct 27, 2025
0fcf485
Apply review suggestions
beryllium Oct 27, 2025
1faeabf
Remove csprng-specific html entity
beryllium Oct 28, 2025
bf61b48
Add invalid offset ValueError information to strrpos-related methods
beryllium Oct 28, 2025
223c47f
Fix whitespace for strprpos error message info
beryllium Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions reference/mbstring/functions/mb-stripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,19 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
13 changes: 13 additions & 0 deletions reference/mbstring/functions/mb-strpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,19 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
14 changes: 9 additions & 5 deletions reference/mbstring/functions/mb-strripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,18 @@
</para>
</refsect1>

<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>
-->

<refsect1 role="changelog">
&reftitle.changelog;
Expand Down
13 changes: 13 additions & 0 deletions reference/mbstring/functions/mb-strrpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,19 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
13 changes: 13 additions & 0 deletions reference/strings/functions/stripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,19 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
13 changes: 13 additions & 0 deletions reference/strings/functions/strpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,19 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
13 changes: 13 additions & 0 deletions reference/strings/functions/strripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
13 changes: 13 additions & 0 deletions reference/strings/functions/strrpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,19 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down