Script to automatically create doc stubs for compat flags #5839
+362
−0
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
dom96
reviewed
Jan 7, 2026
|
|
||
| # Find all field definitions | ||
| # Pattern: field_name @number :Bool followed by annotations and comments | ||
| pattern = r"(\w+)\s+@\d+\s*:Bool\s*([^;]*);" |
Contributor
There was a problem hiding this comment.
Could you use pycapnp here instead to parse the capnp file and avoid using regex?
Member
Author
There was a problem hiding this comment.
I don't think it preserves comments?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
I asked Claude to vibe code a script to generate stub documentation for compatibility flags. It looks through
compatibility-date.capnpand automatically makes a markdown file incloudflare-docsfor each flag it finds that meets the criteria. You'll still need to tweak the output before committing to remove any 'inside baseball' details about the implementation that aren't interesting for users, but this will get you started.Currently it'll document flags that:
Let me know if you'd find this script useful too.
See here for the output it produces (after my manual editing): cloudflare/cloudflare-docs#27450