-
-
Notifications
You must be signed in to change notification settings - Fork 490
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
[Documentation]: WordPress.DB.PreparedSQL #2454
[Documentation]: WordPress.DB.PreparedSQL #2454
Conversation
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
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 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the update @jaymcp and sorry for my slow response.
All good now. As far as I'm concerned, this is ready for merge.
For whomever merges this: please squash-merge.
Description
This PR adds documentation for the
WordPress.DB.PreparedSQL
sniff.Related issues/external references
Part of #1722