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

Actionpack documentation typos [ci skip] #24697

Merged
merged 1 commit into from
Apr 23, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions actionpack/lib/action_controller/metal/force_ssl.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
require 'active_support/core_ext/hash/slice'

module ActionController
# This module provides a method which will redirect browser to use HTTPS
# This module provides a method which will redirect the browser to use HTTPS
# protocol. This will ensure that user's sensitive information will be
# transferred safely over the internet. You _should_ always force browser
# transferred safely over the internet. You _should_ always force the browser
Copy link
Member

Choose a reason for hiding this comment

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

These changes are ok, when they are accompanied with other ones below.

# to use HTTPS when you're transferring sensitive information such as
# user authentication, account information, or credit card information.
#
# Note that if you are really concerned about your application security,
# you might consider using +config.force_ssl+ in your config file instead.
# That will ensure all the data transferred via HTTPS protocol and prevent
# user from getting session hijacked when accessing the site under unsecured
# HTTP protocol.
# the user from getting their session hijacked when accessing the site over
# unsecured HTTP protocol.
module ForceSSL
extend ActiveSupport::Concern
include AbstractController::Callbacks
Expand Down
4 changes: 2 additions & 2 deletions actionpack/lib/action_controller/metal/http_authentication.rb
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,9 @@ def nonce(secret_key, time = Time.now)
end

# Might want a shorter timeout depending on whether the request
# is a PATCH, PUT, or POST, and if client is browser or web service.
# is a PATCH, PUT, or POST, and if the client is a browser or web service.
# Can be much shorter if the Stale directive is implemented. This would
# allow a user to use new nonce without prompting user again for their
# allow a user to use new nonce without prompting the user again for their
# username and password.
def validate_nonce(secret_key, request, value, seconds_to_timeout=5*60)
return false if value.nil?
Expand Down
4 changes: 2 additions & 2 deletions actionpack/lib/action_controller/metal/instrumentation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ def halted_callback_hook(filter)
ActiveSupport::Notifications.instrument("halted_callback.action_controller", :filter => filter)
end

# A hook which allows you to clean up any time taken into account in
# views wrongly, like database querying time.
# A hook which allows you to clean up any time, wrongly taken into account in
# views, like database querying time.
Copy link
Member

Choose a reason for hiding this comment

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

Lets keep previous one

Copy link
Member

Choose a reason for hiding this comment

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

Nevermind.

#
# def cleanup_view_runtime
# super - time_taken_in_something_expensive
Expand Down
4 changes: 2 additions & 2 deletions actionpack/lib/action_controller/metal/live.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'active_support/json'

module ActionController
# Mix this module in to your controller, and all actions in that controller
# Mix this module into your controller, and all actions in that controller
# will be able to stream data to the client as it's written.
#
# class MyController < ActionController::Base
Expand All @@ -20,7 +20,7 @@ module ActionController
# end
# end
#
# There are a few caveats with this use. You *cannot* write headers after the
# There are a few caveats with this module. You *cannot* write headers after the
# response has been committed (Response#committed? will return truthy).
# Calling +write+ or +close+ on the response stream will cause the response
# object to be committed. Make sure all headers are set before calling write
Expand Down