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.

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

Jump to bottom

Correct the type of $tidy->errorBuffer #3528

Merged
merged 1 commit into from
Jul 9, 2024
Merged

Correct the type of $tidy->errorBuffer #3528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion reference/tidy/tidy/errorbuffer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (property):</para>
<fieldsynopsis><modifier>public</modifier> <type>string</type><varname linkend="tidy.props.errorbuffer">tidy-&gt;errorBuffer</varname></fieldsynopsis>
<fieldsynopsis><modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><varname linkend="tidy.props.errorbuffer">tidy-&gt;errorBuffer</varname></fieldsynopsis>
<para>&style.procedural;:</para>
Copy link
Member

Choose a reason for hiding this comment

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

RIght. It looks like the tidy properties are not documented according to the stubs (tidy::$value isn't documented at all). /cc @kocsismate

Copy link
Member Author

Choose a reason for hiding this comment

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

They actually are documented on the class overview page: https://www.php.net/manual/en/class.tidy
This page is about the error buffer itself.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, indeed! I was looking at https://www.php.net/manual/en/book.tidy.php, where ::$value is missing. And also all properties of tidyNode. Might be a PhD issue; I'll see to it.

Copy link
Member

Choose a reason for hiding this comment

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

Actually, there is no issue; it's just that ::$errorBuffer is documented on its own page, while ::$value is documented on the class page. Sorry for the noise.

<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>tidy_get_error_buffer</methodname>
Expand Down
Loading