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

Fix #79168: Missing __construct method documentation in SPL Exceptions #43

Closed
wants to merge 2 commits into from
Closed

Fix #79168: Missing __construct method documentation in SPL Exceptions #43

wants to merge 2 commits into from

Conversation

carusogabriel
Copy link
Contributor

Generalizing the Exception::__construct documentation to methodsynopsis
instead of constructorsynopsis will include it in SPL Exception queries.

Copy link
Contributor

@cmb69 cmb69 left a comment

Choose a reason for hiding this comment

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

The current status is that we want to <xi:include> both (and also the <destructorsynopsis> if available), see http://svn.php.net/viewvc/phpdoc/doc-base/trunk/RFC/skeletons/classname.xml?view=markup. Also an <xi:fallback /> should be inserted as child element (otherwise missing elements would error). Unfortunately, this doesn't prevent a notice/warning (from configure.php or PhD), so we better avoid adding <xi:include>s for elements which don't exist.

@carusogabriel
Copy link
Contributor Author

@cmb69 So the action point here is to add <xi:include /> of constructorsynopsis to all SPL Exception with an <xi:fallback />?

@cmb69
Copy link
Contributor

cmb69 commented Feb 16, 2020

Yes. Basically like http://svn.php.net/viewvc?view=revision&revision=345155.

@carusogabriel
Copy link
Contributor Author

ping @cmb69 just to make sure everything is okay and we can merge this one :)

Copy link
Contributor

@cmb69 cmb69 left a comment

Choose a reason for hiding this comment

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

Thanks for the ping!

The actual fix is fine, so I've applied it as http://svn.php.net/viewvc?view=revision&revision=349537.

Whitespace changes are a particular issue for the English docs, though, since these make the updates harder for translators to catch up; therefore I did not commit this part. Not sure if these should ever be done on a "large" scale. If all (active) translation were up-to-date, this could be done for all languages in one go (using a script which updates the EN-Revisions automatically), but this is unfortunately not the case. If you feel strongly enough regarding this cosmetic fix, I suggest writing to the docs mailing list – maybe a suitable solution can be found.

@cmb69 cmb69 closed this Mar 27, 2020
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.

None yet

2 participants