Merge pull request #346 from ltx-dev/spelling-fixes

Fixed minor spelling mistakes

lib/github_api/api/arguments.rb

@@ -7,7 +7,7 @@
 
 module Github
   class API
-    # A class responsible for handilng request arguments
+    # A class responsible for handling request arguments
     class Arguments
       include Normalizer
       include ParameterFilter

lib/github_api/api/config.rb

@@ -73,7 +73,7 @@ def self.property_names
         property_set.properties.map(&:name)
       end
 
-      # Fetach all the properties and their values
+      # Fetch all the properties and their values
       #
       # @return [Hash[Symbol]]
       #

lib/github_api/client/activity/starring.rb

@@ -118,7 +118,7 @@ def star(*args)
     #   github.activity.starring.unstar 'user-name', 'repo-name'
     #
     # @example
-    #   github.activit.starring.unstar user: 'user-name', repo: 'repo-name'
+    #   github.activity.starring.unstar user: 'user-name', repo: 'repo-name'
     #
     # @api public
     def unstar(*args)

lib/github_api/client/activity/watching.rb

@@ -13,7 +13,7 @@ class Client::Activity::Watching < API
     # @example
     #   github = Github.new
     #   github.activity.watching.list user: 'user-name', repo: 'repo-name'
-    #   github.activity.watching.list user: 'user-naem', repo: 'repo-name' { |watcher| ... }
+    #   github.activity.watching.list user: 'user-name', repo: 'repo-name' { |watcher| ... }
     #
     # @api public
     def list(*args)

lib/github_api/client/gists.rb

@@ -143,7 +143,7 @@ def create(*args)
     #   Optional string
     # @option [Hash] :files
     #   Optional hash - Files that make up this gist.
-    #   The key of which should be a optional string filename and 
+    #   The key of which should be a optional string filename and
     #   the value another optional hash with parameters:
     #     @option [String] :content
     #       Updated string - Update file contents.
@@ -213,7 +213,7 @@ def star(*args)
     #
     # @see https://developer.github.com/v3/gists/#unstar-a-gist
     #
-    # @xample
+    # @example
     #  github = Github.new
     #  github.gists.unstar 'gist-id'
     #

lib/github_api/client/gists/comments.rb

@@ -85,7 +85,7 @@ def edit(*args)
     #
     # @see https://developer.github.com/v3/gists/comments/#delete-a-comment
     #
-    # @xample
+    # @example
     #   github = Github.new
     #   github.gists.comments.delete 'gist-id', 'comment-id'
     #

lib/github_api/client/markdown.rb

@@ -5,7 +5,7 @@
 module Github
   class Client::Markdown < API
 
-    # Render an arbritrary Markdown document
+    # Render an arbitrary Markdown document
     #
     # = Parameters
     #  <tt>:text</tt> - Required string - The Markdown text to render

lib/github_api/client/orgs/teams.rb

@@ -79,7 +79,7 @@ def get(*args)
     #    * pull - team members can pull, but not push or
     #             administor this repositories.
     #    * push - team members can pull and push,
-    #             but not administor this repositores.
+    #             but not administer this repositores.
     #    * admin - team members can pull, push and
     #              administor these repositories.
     #   Default: pull
@@ -125,9 +125,9 @@ def create(*args)
     #    * pull - team members can pull, but not push or
     #             administor this repositories.
     #    * push - team members can pull and push,
-    #             but not administor this repositores.
+    #             but not administer this repositores.
     #    * admin - team members can pull, push and
-    #              administor these repositories.
+    #              administer these repositories.
     #   Default: pull
     #
     # @example

lib/github_api/client/repos.rb

@@ -183,7 +183,7 @@ def get_by_id(*args)
     end
     alias :find_by_id :get_by_id
 
-    # Create a new repository for the autheticated user.
+    # Create a new repository for the authenticated user.
     #
     # @param [Hash] params
     # @option params [String] :name

lib/github_api/client/repos/branches/protections.rb

@@ -40,7 +40,7 @@ def get(*args)
     #   Required.
     # @input params [String] :required_pull_request_reviews
     #   Required.
-    # Look to the branch protection API t see how to use these
+    # Look to the branch protection API to see how to use these
     # https://developer.github.com/v3/repos/branches/#update-branch-protection
     #
     # @example

lib/github_api/client/repos/contents.rb

@@ -66,12 +66,12 @@ def get(*args)
     #
     # @param [Hash] params
     # @option params [String] :path
-    #   Requried string. The content path
+    #   Required string. The content path
     # @option params [String]
     # @option params [String] :message
-    #   Requried string. The commit message.
+    #   Required string. The commit message.
     # @option params [String] :content
-    #   Requried string. The new file content, which will be Base64 encoded
+    #   Required string. The new file content, which will be Base64 encoded
     # @option params [String] :branch
     #   The branch name. If not provided, uses the repository’s
     #   default branch (usually master)

lib/github_api/client/repos/deployments.rb

@@ -24,7 +24,7 @@ class Client::Repos::Deployments < API
 
     # List deployments on a repository
     #
-    # @xample
+    # @example
     #  github = Github.new
     #  github.repos.deployments.list 'user-name', 'repo-name'
     #  github.repos.deployments.list 'user-name', 'repo-name' { |deployment| ... }

lib/github_api/error/service_error.rb

@@ -33,7 +33,7 @@ def self.error_mapping
 
       MIN_BODY_LENGTH = 2
 
-      # Crate a ServiceError
+      # Create a ServiceError
       #
       # @param [Hash[Symbol]] response
       #

lib/github_api/pagination.rb

@@ -14,7 +14,7 @@ def links
       @links = Github::PageLinks.new(env[:response_headers])
     end
 
-    # Retrive number of total pages base on current :per_page parameter
+    # Retrieve number of total pages base on current :per_page parameter
     def count_pages
       page_iterator.count.to_i
     end
@@ -43,7 +43,7 @@ def each_page
       end
     end
 
-    # Retrives the result of the first page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the first page. Returns <tt>nil</tt> if there is
     # no first page - either because you are already on the first page
     # or there are no pages at all in the result.
     def first_page
@@ -52,15 +52,15 @@ def first_page
       first_request
     end
 
-    # Retrives the result of the next page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the next page. Returns <tt>nil</tt> if there is
     # no next page or no pages at all.
     def next_page
       next_request = page_iterator.next
       self.instance_eval { @env = next_request.env } if next_request
       next_request
     end
 
-    # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the previous page. Returns <tt>nil</tt> if there is
     # no previous page or no pages at all.
     def prev_page
       prev_request = page_iterator.prev
@@ -69,7 +69,7 @@ def prev_page
     end
     alias :previous_page :prev_page
 
-    # Retrives the result of the last page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the last page. Returns <tt>nil</tt> if there is
     # no last page - either because you are already on the last page,
     # there is only one page or there are no pages at all in the result.
     def last_page
@@ -78,7 +78,7 @@ def last_page
       last_request
     end
 
-    # Retrives a specific result for a page given page number.
+    # Retrieves a specific result for a page given page number.
     # The <tt>page_number</tt> parameter is not validate, hitting a page
     # that does not exist will return Github API error. Consequently, if
     # there is only one page, this method returns nil

lib/github_api/validations/presence.rb

@@ -7,7 +7,7 @@ module Validations
     # A mixin to help validate presence of non-empty values
     module Presence
 
-      # Ensure that esential arguments are present before request is made.
+      # Ensure that essential arguments are present before request is made.
       #
       # == Parameters
       #  Hash/Array of arguments to be checked against nil and empty string