[Documentation]: WordPress.DB.PreparedSQL #2454
Conversation
jaymcp
force-pushed
the
docs/WordPress.DB.PreparedSQL
branch
from
56261de to
9a0a228
Compare
|
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 |
|
Thanks @GaryJones, I've addressed the missing emphasis in fdd28c7. |
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
@jaymcp Hi Jay,
Thanks for working on this! Looking good!
I've gone through it with a critical eye and while the code samples were correct as they were, I have a feeling changing them a little would make the problem the sniff flags more obvious for people to grasp.
As, with the changes I made, some lines would become too long for code samples in docs, I've also broken up the SQL queries over multiple lines.
Let me know what you think about these suggestions.
jrfnl
added
Status: Awaiting feedback
Component: Core
Focus: DB
and removed
Status: Review ready
labels
Rewrites code examples to be clearer, and adds highlighting. Props: @jrfnl Co-authored-by: Juliette <[email protected]>
Props: @jrfnl Co-authored-by: Juliette <[email protected]>
|
Thanks @jrfnl, I appreciate the thorough feedback. I have committed all of your suggestions 🙂 |
* upstream/develop: (428 commits) Rulesets: update schema URL GH Actions: use the xmllint-validate action runner and enhance checks (WordPress#2522) AbstractFunctionParameterSniff: fix first class callables and function imports (WordPress#2518) DontExtractStandard.xml file creation (WordPress#2456) Add documentation for WordPress.NamingConventions.ValidVariableName (WordPress#2457) Remove unused variables from a few sniffs (WordPress#2514) I18nTextDomainFixer: remove unnecessary variable initialization (WordPress#2513) GH Actions: Bump codecov/codecov-action from 4 to 5 (WordPress#2510) GH Actions: PHP 8.4 has been released CS/QA: remove redundant condition GH Actions: use explicit PHPStan major Various sniffs: simplify skipping the rest of the file GH Actions: always quote variables Release checklist: add new action item AbstractClassRestrictionsSniff: fix insufficient defensive coding (WordPress#2500) ✨ New WordPress.WP.GetMetaSingle sniff (WordPress#2465) Fix typo in AbstractFunctionRestrictionsSniff::is_targetted_token() DocBlock (WordPress#2477) Fix typos (WordPress#2472) Documentation: capitalization consistency fixes (WordPress#2469) [Documentation]: WordPress.DB.PreparedSQL (WordPress#2454) ...
4 participants
Description
This PR adds documentation for the
WordPress.DB.PreparedSQLsniff.Related issues/external references
Part of #1722