Several ActionCable doc fixes #23429
Conversation
|
r? @sgrif (@rails-bot has picked a reviewer for you, use r? to override) |
| # "web_notifications_1", { title: 'New things!', body: 'All shit fit for print' } | ||
| # # Somewhere in your app this is called, perhaps from a NewCommentJob | ||
| # ActionCable.server.broadcast \ | ||
| # "web_notifications_1", { title: 'New things!', body: 'All that's fit for print' } |
There was a problem hiding this comment.
Sorry, didn't spot this before: unescaped quote
There was a problem hiding this comment.
Nice catch, fixed + force pushed (again).
On Tue, Feb 2, 2016 at 2:26 PM, Matthew Draper notifications@github.com
wrote:
In actioncable/lib/action_cable/server/broadcasting.rb
#23429 (comment):#
# Somewhere in your app this is called, perhaps from a NewCommentJob
ActionCable.server.broadcast \
"web_notifications_1", { title: 'New things!', body: 'All shit fit for print' }
# Somewhere in your app this is called, perhaps from a NewCommentJob
ActionCable.server.broadcast \
"web_notifications_1", { title: 'New things!', body: 'All that's fit for print' }
Sorry, didn't spot this before: unescaped quote
—
Reply to this email directly or view it on GitHub
https://github.com/rails/rails/pull/23429/files#r51620418.
|
@qrush this needs a squash of commits + [ci skip] in the commit message. Thanks! |
| @@ -32,7 +32,7 @@ module Channel | |||
| # | |||
| # == Action processing | |||
| # | |||
| # Unlike Action Controllers, channels do not follow a REST constraint form for its actions. It's a remote-procedure call model. You can | |||
| # Unlike ActionControllers, channels do not follow a REST constraint form for their actions. It's a remote-procedure call model. You can | |||
There was a problem hiding this comment.
I don't think we've ever used ActionControllers (with or without the space) to mean "instances of AC::Base". It feels awkward to me, but I don't have a concrete suggestion for an alternative. 😕
There was a problem hiding this comment.
Good point, felt weird to me too. Reworked to say "subclasses of".
qrush
force-pushed
the
actioncable-doc-update
branch
2 times, most recently
from
80ebf45
to
c8e782f
Compare
|
Rebased. 🔪 |
| # Unlike Action Controllers, channels do not follow a REST constraint form for its actions. It's a remote-procedure call model. You can | ||
| # declare any public method on the channel (optionally taking a data argument), and this method is automatically exposed as callable to the client. | ||
| # Unlike subclasses of ActionController::Base, channels do not follow a REST | ||
| # constraint form for their actions. It's a remote-procedure call model. You |
There was a problem hiding this comment.
Instead, ActionCable operates through a remote-procedure call model.
|
Few small grammar notes 😄 |
qrush
force-pushed
the
actioncable-doc-update
branch
from
c8e782f
to
c96f7fe
Compare
|
Rebased again + a few more nits from @maclover7. I think this is ready to merge. |
* Properly indent code sample in ActionCable::Channel::Streams * Add a doc comment for #stop_all_streams * Reformat + add <tt> blocks around code references in ActionCable::Base docs * Clarify and a little better grammar on ActionCable::RemoteConnections * Correct indentation and clean up ActionCable::Server::Broadcasting code sample
qrush
force-pushed
the
actioncable-doc-update
branch
from
c96f7fe
to
8305437
Compare
Several ActionCable doc fixes
|
Thanks!!!! |
Correcting indentation, grammar, and a few other nits. 🔏