Remove FIXME placeholders from generated doc snippets #36343
+4
−2
Conversation
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
The Python and Java snippet generators ([utils/doclint/generatePythonSnippets.js](cci:7://file:///d:/Github/playwright/utils/doclint/generatePythonSnippets.js:0:0-0:0) and [utils/doclint/generateJavaSnippets.js](cci:7://file:///d:/Github/playwright/utils/doclint/generateJavaSnippets.js:0:0-0:0)) prepended every generated example with a `# FIXME` / `// FIXME` placeholder comment. These lines leaked into the public docs, confusing readers, polluting copy-pasted code, and adding unnecessary noise to documentation diffs. This patch simply removes the placeholder prefix so the generators now emit clean, production-ready code snippets.
mxschmitt
requested changes
Jun 17, 2025
Test results for "tests 1"1 failed 3 flaky39417 passed, 822 skipped Merge workflow run. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Python and Java snippet generators (utils/doclint/generatePythonSnippets.js
and utils/doclint/generateJavaSnippets.js) prepended every generated example
with a
# FIXME/// FIXMEplaceholder comment.These lines leaked into the public docs, confusing readers, polluting copy-pasted
code, and adding unnecessary noise to documentation diffs.
This patch simply removes the placeholder prefix so the generators now emit
clean, production-ready code snippets.