-
Notifications
You must be signed in to change notification settings - Fork 757
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
Hooks documentation #4094
Hooks documentation #4094
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have only reviewed the XML markup for the moment
<row xml:id="constant.property"> | ||
<entry><constant>__PROPERTY__</constant></entry> | ||
<entry> | ||
Only valid inside a <link linkend="language.oop5.property-hooks">property hook</link>. It is equal to the name of the property. | ||
</entry> | ||
</row> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note this also adds the T_PROPERTY_C
token to the tokenizer extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I... don't know what that means? Is that something relevant for the docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, in that it needs to be documented in the appendices/tokens.xml
file/page :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to leave this one to @iluuu1994, since he knows what it actually does.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do I still need to do something here? Are we documenting individual tokens?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to @Girgias, we need something about T_PROPERTY_C
in appendices/tokens.xml
. I have no idea what that would be or what it means. I can review and merge a PR from you, however. :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've already documented this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you Gina!
I think this covers the hooks page itself. Interfaces and abstract classes I think should go on their own pages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also please change all new <para>
to <simpara>
as it doesn't seem like you are nesting any complicated tags inside of them.
Co-authored-by: Gina Peter Banyard <girgias@php.net>
I updated para to simpara in the new file. I didn't change the existing files, as IMO making the files a mix of para and simpara is even worse, and changing the whole file is scope creep. We can/should do that separately in another PR. I still don't know why the build is failing, as the error messages are unhelpful. It's some kind of not-property-structured XML, I suspect, but XML is very bad about telling you where the actual problem is. 😢 ... OK, now it's not failing on CI, but it is still failing for me locally. Whatever. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nits but otherwise LGTM.
Co-authored-by: Gina Peter Banyard <girgias@php.net>
This is now ready for content review. Should be mergeable.