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 Example section, Notes section before changelog #3819

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

sy-records
Copy link
Member

No description provided.

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!

@jimwins
Copy link
Member

jimwins commented Oct 1, 2024

Do we have the preferred order of these sections documented anywhere? The docgen templates in the doc-base repo don't include examples, notes, changelog, or see also. (Maybe it should, commented out?)

@cmb69
Copy link
Member

cmb69 commented Oct 1, 2024

Do we have the preferred order of these sections documented anywhere?

See https://github.com/php/doc-base/blob/master/RFC/skeletons/function.xml (and maybe elsewhere).

Maybe it should, commented out?

+1

@Girgias
Copy link
Member

Girgias commented Oct 1, 2024

We have a QA script that should check this, but it is brittle as it doesn't follow XIncludes

@Girgias Girgias merged commit 6c550e6 into php:master Oct 1, 2024
2 checks passed
@sy-records sy-records deleted the fix/order branch October 1, 2024 22:02
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.

4 participants