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

Add missing param/return value sections #1459

Merged
merged 2 commits into from
Apr 2, 2022

Conversation

Girgias
Copy link
Member

@Girgias Girgias commented Mar 13, 2022

This, with #1457, fixes the remain (current) issues raised by the section order QA script #658.

After merging both of them we should add the check to CI so that a PR can't introduce section ordering issues.

<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
Copy link
Member Author

Choose a reason for hiding this comment

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

I wonder if this shouldn't be changed in php-src as it's weird it's the only one called name instead of attribute.

@Crell
Copy link
Contributor

Crell commented Mar 30, 2022

Seems OK to me. Is there anything blocking a merge?

@Girgias Girgias force-pushed the qa-section-order-script-fix branch from 13ffc7d to e9167fd Compare April 2, 2022 12:57
Copy link
Member

@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.

Thank you! The nested <variablelist>s are semantically cleaner, and so it's fine to go with this. My idea was to use <simplelist>s for the inner level, which might look nicer on the screen:
Screenshot 2022-04-02 162011
vs.
Screenshot 2022-04-02 162222

But as I said, I'm fine with the current status, too.

@Girgias Girgias merged commit e84773a into php:master Apr 2, 2022
@Girgias Girgias deleted the qa-section-order-script-fix branch April 2, 2022 14:34
tiffany-taylor pushed a commit to tiffany-taylor/doc-en that referenced this pull request Jan 16, 2023
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