Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fix docs (closes #2679) [coffee2code]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2909 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
commit ea5bd8e75664e3d6e3c4bf51ba033f67ce9069f0 1 parent 6ab9f2b
David Heinemeier Hansson dhh authored
10 actionwebservice/README
View
@@ -21,14 +21,14 @@ You specify the methods you want to make available as API methods in an
ActionWebService::API::Base derivative, and then specify this API
definition class wherever you want to use that API.
-The implementation of the methods is done seperately to the API
+The implementation of the methods is done separately from the API
specification.
==== Method name inflection
Action Web Service will camelcase the method names according to Rails Inflector
-rules for the API visible to public callers. What this means, for example
+rules for the API visible to public callers. What this means, for example,
is that the method names in generated WSDL will be camelcased, and callers will
have to supply the camelcased name in their requests for the request to
succeed.
@@ -222,12 +222,12 @@ If you're going to be sending back strings containing non-ASCII UTF-8
characters using the <tt>:string</tt> data type, you need to make sure that
Ruby is using UTF-8 as the default encoding for its strings.
-The default in Ruby to use US-ASCII encoding for strings, which causes a string
+The default in Ruby is to use US-ASCII encoding for strings, which causes a string
validation check in the Ruby SOAP library to fail and your string to be sent
back as a Base-64 value, which may confuse clients that expected strings
because of the WSDL.
-Two ways of doing setting the default string encoding are:
+Two ways of setting the default string encoding are:
* Start Ruby using the <tt>-Ku</tt> command-line option to the Ruby executable
* Set the <tt>$KCODE</tt> flag in <tt>config/environment.rb</tt> to the
@@ -334,7 +334,7 @@ Action Web Service requires that the Action Pack and Active Record are either
available to be required immediately or are accessible as GEMs.
It also requires a version of Ruby that includes SOAP support in the standard
-library. At least version 1.8.2 final (2004-12-25) of Ruby is recommended, this
+library. At least version 1.8.2 final (2004-12-25) of Ruby is recommended; this
is the version tested against.
2  actionwebservice/install.rb
View
@@ -4,7 +4,7 @@
include Config
-# this was adapted from rdoc's install.rb by ways of Log4r
+# this was adapted from rdoc's install.rb by way of Log4r
$sitedir = CONFIG["sitelibdir"]
unless $sitedir
4 actionwebservice/lib/action_web_service/api.rb
View
@@ -18,7 +18,7 @@ class Base
class_inheritable_option :inflect_names, true
# Whether to allow ActiveRecord::Base models in <tt>:expects</tt>.
- # The default is +false+, you should be aware of the security implications
+ # The default is +false+; you should be aware of the security implications
# of allowing this, and ensure that you don't allow remote callers to
# easily overwrite data they should not have access to.
class_inheritable_option :allow_active_record_expects, false
@@ -43,7 +43,7 @@ class << self
# A signature is an array of one or more parameter specifiers.
# A parameter specifier can be one of the following:
#
- # * A symbol or string of representing one of the Action Web Service base types.
+ # * A symbol or string representing one of the Action Web Service base types.
# See ActionWebService::SignatureTypes for a canonical list of the base types.
# * The Class object of the parameter type
# * A single-element Array containing one of the two preceding items. This
8 actionwebservice/lib/action_web_service/container/action_controller_container.rb
View
@@ -25,12 +25,12 @@ module ClassMethods
# now exist on the controller, and calling it will return the
# XML-RPC client object for working with that remote service.
#
- # +options+ is the set of protocol client specific options,
- # see a protocol client class for details.
+ # +options+ is the set of protocol client specific options (see
+ # a protocol client class for details).
#
# If your API definition does not exist on the load path with the
- # correct rules for it to be found using +name+, you can pass through
- # the API definition class in +options+, using a key of <tt>:api</tt>
+ # correct rules for it to be found using +name+, you can pass in
+ # the API definition class via +options+, using a key of <tt>:api</tt>
def web_client_api(name, protocol, endpoint_uri, options={})
unless method_defined?(name)
api_klass = options.delete(:api) || require_web_service_api(name)
2  actionwebservice/lib/action_web_service/container/delegated_container.rb
View
@@ -11,7 +11,7 @@ def self.append_features(base) # :nodoc:
end
module ClassMethods
- # Declares a web service that will provides access to the API of the given
+ # Declares a web service that will provide access to the API of the given
# +object+. +object+ must be an ActionWebService::Base derivative.
#
# Web service object creation can either be _immediate_, where the object
Please sign in to comment.
Something went wrong with that request. Please try again.