Regenerate ext/mysqli class and method synopses from stubs #1271
Conversation
kocsismate
force-pushed
the
mysqli-stubs2
branch
from
7d6926d to
507f60d
Compare
| @@ -0,0 +1,57 @@ | |||
| <?xml version="1.0" encoding="utf-8"?> | |||
There was a problem hiding this comment.
This documentation is incomplete, so any help is welcome
There was a problem hiding this comment.
There's very little point in documenting this as it's not really usable on its own. But if we are documenting, can you make an entry in the versions.xml file, please?
There was a problem hiding this comment.
In my opinion, it is very import to document that this is not usable on its own (and that it's only meaninful for internal usage).
There was a problem hiding this comment.
Alright, I'll try to come up with a suitable description (I was't aware that the constructor is not usable on its own until now).
reference/mysqli/mysqli/init.xml
Outdated
| @@ -40,7 +40,7 @@ | |||
| <refsect1 role="returnvalues"> | |||
| &reftitle.returnvalues; | |||
| <para> | |||
| Returns an object. | |||
| Returns &null; on success, &return.falseforfailure;. | |||
There was a problem hiding this comment.
Both are correct. We should keep both or maybe just split the page into two separate entries.
There was a problem hiding this comment.
Ahh, I didn't realize that both the procedural and the OOP version is documented on the same page. I'll simply keep both for now, and then a followup fix can do further changes.
There was a problem hiding this comment.
Yep, that's a mess, but splitting into multiple pages might not the best solution, either.
| @@ -0,0 +1,57 @@ | |||
| <?xml version="1.0" encoding="utf-8"?> | |||
There was a problem hiding this comment.
There's very little point in documenting this as it's not really usable on its own. But if we are documenting, can you make an entry in the versions.xml file, please?
kocsismate
force-pushed
the
mysqli-stubs2
branch
from
cdba300 to
a424c68
Compare
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
|
Thank you for the review! |
Follow-up to #301