Skip to content
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.

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

ext/bcmath: Correctly modified an existing document #4163

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

SakiTakamachi
Copy link
Member

Fixed and added exception behavior.
Also added a <literal> tag.

Comment on lines 55 to 64
<refsect1 role="errors">
&reftitle.errors;
<para>
This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
<simplelist>
<member><parameter>num1</parameter> or <parameter>num2</parameter> is not a well-formed BCMath numeric string</member>
<member><parameter>scale</parameter> is outside the valid range</member>
</simplelist>
</para>
</refsect1>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considering how often this is repeated I would use XIncludes to avoid the repetition

@SakiTakamachi
Copy link
Member Author

fixed

@Girgias
Copy link
Member

Girgias commented Nov 29, 2024

@SakiTakamachi I pushed a bunch of wording fixes and docs fixes which are existing issues, as I wanted to check locally that everything renders somewhat as expected.

Copy link
Member

@nielsdos nielsdos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nits, otherwise ok

<simplelist>
<member>
<parameter>num1</parameter> or <parameter>num2</parameter>
is not a well-formed BCMath numeric string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is not a well-formed BCMath numeric string
is not a well-formed BCMath numeric string.

is not a well-formed BCMath numeric string
</member>
<member>
<parameter>scale</parameter> is outside the valid range
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<parameter>scale</parameter> is outside the valid range
<parameter>scale</parameter> is outside the valid range.

<para>
This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
<simplelist>
<member><parameter>num</parameter> is not a well-formed BCMath numeric string</member>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<member><parameter>num</parameter> is not a well-formed BCMath numeric string</member>
<member><parameter>num</parameter> is not a well-formed BCMath numeric string.</member>

This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
<simplelist>
<member><parameter>num</parameter> is not a well-formed BCMath numeric string</member>
<member><parameter>scale</parameter> is outside the valid range</member>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<member><parameter>scale</parameter> is outside the valid range</member>
<member><parameter>scale</parameter> is outside the valid range.</member>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants