Skip to content

Document several missing compat flags #19129

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Apr 29, 2025
Merged

Document several missing compat flags #19129

merged 10 commits into from
Apr 29, 2025

Conversation

@jasnell
Copy link
Contributor

@jasnell jasnell commented Jan 10, 2025

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

hyperlint-ai[bot]
hyperlint-ai bot reviewed Jan 10, 2025
View reviewed changes
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 files reviewed, 2 total issue(s) found.

@jasnell @hyperlint-ai
Apply suggestions from code review
f2fa829 
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
@ToriLindsay ToriLindsay self-requested a review February 11, 2025 16:16
ToriLindsay
ToriLindsay approved these changes Feb 11, 2025
View reviewed changes
Copy link
Contributor

@ToriLindsay ToriLindsay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some grammar/clarity comments

@ToriLindsay
Copy link
Contributor

ToriLindsay commented Apr 8, 2025

Hi @jasnell - I left some suggestions on this a while back. But other than that, is this ready to merge? Just checking since it's been sitting a while. Thanks!

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 21, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Documented several compatibility flags related to Workers API behavior changes.

  • Added documentation for the 'Disable top-level await in require(...)' compatibility flag.
  • Introduced the 'Apply TransformStream backpressure fix' compatibility flag documentation.
  • Documented the 'Automatically set the Symbol.toStringTag for Workers API objects' compatibility flag.
  • Added information on the 'Upper-case HTTP methods' compatibility flag.

Added Files

  • src/content/compatibility-flags/disable-top-level-await-in-require.md
  • src/content/compatibility-flags/streams-transform-backpressure.md
  • src/content/compatibility-flags/to-string-tag.md
  • src/content/compatibility-flags/upper-case-http-methods.md
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

1 similar comment
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 21, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Documented several compatibility flags related to Workers API behavior changes.

  • Added documentation for the 'Disable top-level await in require(...)' compatibility flag.
  • Introduced the 'Apply TransformStream backpressure fix' compatibility flag documentation.
  • Documented the 'Automatically set the Symbol.toStringTag for Workers API objects' compatibility flag.
  • Added information on the 'Upper-case HTTP methods' compatibility flag.

Added Files

  • src/content/compatibility-flags/disable-top-level-await-in-require.md
  • src/content/compatibility-flags/streams-transform-backpressure.md
  • src/content/compatibility-flags/to-string-tag.md
  • src/content/compatibility-flags/upper-case-http-methods.md
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

ToriLindsay
ToriLindsay approved these changes Apr 21, 2025
View reviewed changes
@jasnell jasnell requested a review from ToriLindsay April 24, 2025 17:18
@vicb vicb merged commit 12a8463 into cloudflare:production Apr 29, 2025
7 checks passed
@vicb
Copy link
Contributor

vicb commented Apr 29, 2025

discussed offline with Tori. She thinks it's ready to merge.
We can amend later if needed but it looks like the PR got solid reviews.

GregBrimble pushed a commit that referenced this pull request May 1, 2025
@jasnell @ToriLindsay @GregBrimble
Document several missing compat flags (#19129)
ed6cbad 
Co-authored-by: ToriLindsay <[email protected]>
daisyfaithauma pushed a commit that referenced this pull request May 7, 2025
@jasnell @ToriLindsay @daisyfaithauma
Document several missing compat flags (#19129)
2942f69 
Co-authored-by: ToriLindsay <[email protected]>
daisyfaithauma pushed a commit that referenced this pull request May 8, 2025
@jasnell @ToriLindsay @daisyfaithauma
Document several missing compat flags (#19129)
6419524 
Co-authored-by: ToriLindsay <[email protected]>
Maddy-Cloudflare pushed a commit that referenced this pull request May 9, 2025
@jasnell @ToriLindsay @Maddy-Cloudflare
Document several missing compat flags (#19129)
65a7e02 
Co-authored-by: ToriLindsay <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner

@mikenomitch mikenomitch Awaiting requested review from mikenomitch mikenomitch is a code owner

@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble is a code owner

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay

1 more reviewer

@hyperlint-ai hyperlint-ai[bot] hyperlint-ai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

Labels

size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jasnell @ToriLindsay @vicb @irvinebroque @mikenomitch @GregBrimble