Fix syntax errors and improve documentation in D1 Worker API#27635
Merged
Oxyjun merged 4 commits intoproductionfrom Jan 19, 2026
Merged
Fix syntax errors and improve documentation in D1 Worker API#27635Oxyjun merged 4 commits intoproductionfrom
Oxyjun merged 4 commits intoproductionfrom
Conversation
- Fix SQL syntax: Add quotes around string literals in examples - Fix JavaScript syntax: Fix invalid getBookmark() return statement - Fix first() method: Add quotes around column parameter - Add explanatory comments to API Playground demonstrating each method - Add context comment explaining env.MY_DB binding source - Improves code quality from 86% to 100% for fixed examples
Oxyjun
requested review from
a team,
elithrar,
harshil1712,
joshthoward,
rozenmd and
vy-ton
as code owners
github-actions
bot
added
size/m
product:d1
github-actions
bot
assigned
elithrar,
harshil1712,
joshthoward,
Oxyjun,
rozenmd and
vy-ton
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
- Fix index.mdx lines 160, 191: Use 3 backticks instead of 4 - Add command documentation about backtick usage to prevent future errors - Ensures MDX parsing works correctly
Contributor
Author
🔧 Additional Fix: Code Block SyntaxFixed an additional issue found after the initial review: Issue: 4 Backticks Instead of 3File: Problem: Code blocks were using 4 backticks (````) instead of the required 3 backticks (```) Fix: Changed all instances to use exactly 3 backticks Impact:
PreventionAdded
This ensures this error won't happen in future code reviews. |
Contributor
Comment on lines
+407
to
+408
| const { bookmark } = session.getBookmark(); | ||
| return bookmark; |
Contributor
There was a problem hiding this comment.
lambrospetrou
approved these changes
Jan 16, 2026
marciocloudflare
approved these changes
Jan 19, 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
8 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.
Code Review Summary
This PR fixes syntax errors and improves documentation in
src/content/docs/d1/worker-api/based on systematic code review.Overall Results:
Critical Fixes
1. SQL Syntax Errors - Missing String Quotes
Files:⚠️ Critical (would fail when executed)
d1-database.mdx(Lines 68, 72),prepared-statements.mdx(Lines 123, 129)Severity:
Before:
After:
Impact: String literals in SQL require single quotes. The original code would throw SQL syntax errors.
2. JavaScript Syntax Error - Invalid Destructuring/Return
File:⚠️ Critical (SyntaxError)
d1-database.mdx(Line 407)Severity:
Before:
After:
Impact: You cannot combine destructuring assignment with a return statement. This would throw a SyntaxError.
3. JavaScript Syntax Error - Missing String Quotes
File:⚠️ Critical
prepared-statements.mdx(Line 410)Severity:
Before:
After:
Impact: The
first()method expects a string parameter for the column name, not a variable reference.Documentation Improvements
4. API Playground - Missing Explanatory Comments
File:
index.mdx(Lines 98-149)Severity: Review Needed (0.0/1.0 for Comments & Documentation)
Changes:
Impact: Developers can now quickly understand what each URL path demonstrates without reading the D1 API documentation.
5. TypeScript Example - Missing Context
File:
index.mdx(Lines 27-39)Severity: Review Recommended (0.4/1.0 for Completeness)
Added:
Impact: Clarifies where the
envobject comes from, helping developers understand the binding configuration.Examples Fixed
1. Static SQL statement examples
d1-database.mdx,prepared-statements.mdx2. getBookmark() method example
d1-database.mdx3. first() column parameter example
prepared-statements.mdx4. API Playground
index.mdx5. TypeScript generic type example
index.mdx📊 Detailed Review Results
Files Reviewed
index.mdx- 2 code blocks reviewedd1-database.mdx- 13 code blocks reviewedprepared-statements.mdx- 14 code blocks reviewedreturn-object.mdx- 3 code blocks reviewedReview Methodology
Each code example was evaluated on:
For Illustrative Examples (3 criteria):
For Demonstrative Examples (5 criteria):
For Executable Examples (8 criteria):
Scoring Guide:
📋 Changes Summary
Files Changed: 3 files, +64/-51 lines
d1-database.mdx: 7 lines changed'Alfreds Futterkiste'(JavaScript)'Alfreds Futterkiste'(Python)prepared-statements.mdx: 6 lines changed'Bs Beverages'(JavaScript)'Bs Beverages'(Python)"CustomerId"parameterindex.mdx: 51 lines changed (comments added, no logic changes)Impact
Before:
After:
Testing