DB/DirectDatabaseQuery: add XML documentation#2697
Merged
dingo-d merged 3 commits intoWordPress:developfrom Mar 5, 2026
Merged
DB/DirectDatabaseQuery: add XML documentation#2697dingo-d merged 3 commits intoWordPress:developfrom
dingo-d merged 3 commits intoWordPress:developfrom
Conversation
- Rewrite standard descriptions to explain why each rule exists. - Add <em> tags to highlight key parts in code examples. - Use realistic code examples. - Replace second caching example with a write + cache invalidation pattern. - Wrap caching examples in functions, as the sniff always generates a NoCaching warning if the caching code is not inside a function. - Remove dbDelta() recommendation from SchemaChange section. I believe the original intent of the rule is to discourage schema changes and not suggest dbDelta() is used. - Remove SchemaChange code comparison (no valid alternative).
jrfnl
reviewed
Feb 24, 2026
Member
jrfnl
left a comment
There was a problem hiding this comment.
@rodrigoprimo Thanks for working on this! Looking good and IMO the examples are helpful.
I just left a few small questions, nothing major.
Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com>
8bc5ac4 to
2a8fc57
Compare
Collaborator
Author
|
Thanks for the review, @jrfnl! I believe I addressed all your suggestions. |
jrfnl
approved these changes
Mar 5, 2026
Member
jrfnl
left a comment
There was a problem hiding this comment.
Thanks for the updates @rodrigoprimo. LGTM.
Member
|
For whomever merges: please squash-merge. |
dingo-d
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds XML documentation for the
WordPress.DB.DirectDatabaseQuerysniff.The documentation is based on the work started by @jaymcp in #2458. I used the original commit and, in a separate commit, made the following changes to the original version of the documentation:
<em>tags to highlight key parts in code examples.dbDelta()recommendation from SchemaChange section. I believe the original intent of the rule is to discourage schema changes and not suggestdbDelta()is used.I suggest squashing the two commits before merging. I'm opening the PR without doing that to make it easier to tell my changes apart from the original changes.
Suggested changelog entry
N/A
Related issues/external references
Related to: #1722
Supersedes: #2458
Closes #2458