Skip to content
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.

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

Update docs about SSE streaming response #47933

Merged
merged 1 commit into from
Apr 15, 2023

Conversation

renny-ren
Copy link
Contributor

@renny-ren renny-ren commented Apr 13, 2023

Motivation / Background

This Pull Request has been created to improve the documentation related to ActionController::Live in Rails.

Based on the findings from rack/rack#1619 and #38466, it has been identified that streaming responses do not work with Rack 2.2 by default, requiring users to implement workarounds in their applications.

Currently, this issue can be time-consuming for users to diagnose and resolve, at least the workaround should be mentioned in the Rails docs/guides to provide better guidance to users.

Detail

This Pull Request updates the docs to explain the issue and provide workarounds.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@rails-bot rails-bot bot added the actionpack label Apr 13, 2023
@guilleiguaran guilleiguaran merged commit c5079e4 into rails:main Apr 15, 2023
8 checks passed
jonathanhefner added a commit that referenced this pull request Apr 16, 2023
Follow-up to #47933.

RDoc does not support backticks the way that Markdown does.  Instead,
inline code must be wrapped with `+` or `<tt>`.
danielvdao pushed a commit to danielvdao/rails that referenced this pull request May 1, 2023
Follow-up to rails#47933.

RDoc does not support backticks the way that Markdown does.  Instead,
inline code must be wrapped with `+` or `<tt>`.
danielvdao pushed a commit to danielvdao/rails that referenced this pull request May 1, 2023
Follow-up to rails#47933.

RDoc does not support backticks the way that Markdown does.  Instead,
inline code must be wrapped with `+` or `<tt>`.
danielvdao pushed a commit to danielvdao/rails that referenced this pull request May 1, 2023
Follow-up to rails#47933.

RDoc does not support backticks the way that Markdown does.  Instead,
inline code must be wrapped with `+` or `<tt>`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants