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 @since notation to block-library PHP files #52720

Open
tellthemachines opened this issue Jul 18, 2023 · 7 comments
Open

Add @since notation to block-library PHP files #52720

tellthemachines opened this issue Jul 18, 2023 · 7 comments
Labels
[Package] Block library /packages/block-library [Type] Code Quality Issues or PRs that relate to code quality

Comments

@tellthemachines
Copy link
Contributor

What problem does this address?

The block library PHP files are automatically synced to core with the package updates, so they should be made core-ready in Gutenberg.

One thing that's missing across the several files is @since notation on the functions. This issue tracks adding it in those files where needed.

@costdev
Copy link
Contributor

costdev commented Jul 18, 2023

For reference: Here is the PHP Documentation standards section relating to @since tags, when they should be added, and such.

@ramonjd
Copy link
Member

ramonjd commented Jul 21, 2023

I've added a few here: #52820

In no way exhaustive

@ndiego
Copy link
Member

ndiego commented Jul 27, 2023

@ramonjd @tellthemachines is there still work to do on this for 6.3?

@tellthemachines
Copy link
Contributor Author

It's unlikely we'll be doing much more here since RC3 is in a few days. Happy for it to be moved to 6.4!

@ramonjd
Copy link
Member

ramonjd commented Jul 28, 2023

is there still work to do on this for 6.3?

Thanks for the question. Yeah, it requires a bit of time to pick through. We might not have caught them all, but the major stuff has been done I think.

@bph bph moved this from 📥 Todo to 🦵 Punted to 6.4 in WordPress 6.3.x Editor Tasks Aug 1, 2023
@bph bph moved this to ❓ Triage in WordPress 6.4 Editor Tasks Aug 2, 2023
@gziolo
Copy link
Member

gziolo commented Aug 4, 2023

Should we enforce usage of @since through the linter in these files? @anton-vlasenko is working on similar enhancements that will make these files compatible with WP Core.

@tellthemachines
Copy link
Contributor Author

Yeah that would be great! We still have to retroactively add it to all the functions though 😅

@bph bph moved this from Triage to Needs Decision / Discussion in WordPress 6.4 Editor Tasks Sep 8, 2023
@bph bph moved this from Needs Decision / Discussion to Punted to 6.5 in WordPress 6.4 Editor Tasks Sep 23, 2023
@bph bph moved this to ❓ Triage in WordPress 6.5 Editor Tasks Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block library /packages/block-library [Type] Code Quality Issues or PRs that relate to code quality
Projects
No open projects
Status: Punted to 6.5
Development

No branches or pull requests

5 participants