WordPress / WordPress-Coding-Standards

PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions
MIT License
2.55k stars 483 forks source link

[Documentation]: WordPress.DB.PreparedSQL #2454

Closed jaymcp closed 2 months ago

jaymcp commented 3 months ago

Description

This PR adds documentation for the WordPress.DB.PreparedSQL sniff.

Related issues/external references

Part of #1722

GaryJones commented 3 months ago

Have a look at some of the existing examples, such as in https://github.com/WordPress/WordPress-Coding-Standards/tree/develop/WordPress/Docs/Arrays to see how the <em> </em> tags are used to emphasise the key bit of the code examples.

jaymcp commented 3 months ago

Thanks @GaryJones, I've addressed the missing emphasis in fdd28c7.

jaymcp commented 3 months ago

Thanks @jrfnl, I appreciate the thorough feedback. I have committed all of your suggestions 🙂