Merge pull request piotrmurach#361 from olleolleolle/fix-yard-annotations

piotrmurach · web-flow · commit 2872bbb68c66 · 2020-04-28T16:53:13.000+01:00
YARD annotations: avoid typos
diff --git a/lib/github_api/api.rb b/lib/github_api/api.rb
@@ -229,7 +229,7 @@ def filter_callbacks(kind, action_name)
 
     # Run all callbacks associated with this action
     #
-    # @apram [Symbol] action_name
+    # @param [Symbol] action_name
     #
     # @api private
     def run_callbacks(action_name, &block)
diff --git a/lib/github_api/client/projects/cards.rb b/lib/github_api/client/projects/cards.rb
@@ -66,8 +66,8 @@ def get(*args)
     #  github.projects.cards.create :column_id, note: 'Card Note'
     #
     # @example
-    # github = Github.new
-    # github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'
+    #   github = Github.new
+    #   github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'
     #
     # @see https://developer.github.com/v3/projects/cards/#create-a-project-card
     #
diff --git a/lib/github_api/client/repos/forks.rb b/lib/github_api/client/repos/forks.rb
@@ -13,8 +13,10 @@ class Client::Repos::Forks < API
     #
     # @example
     #   github = Github.new
-    #   github.repos.forks.list 'user-name', 'repo-name'
-    #   github.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
+    #   github.repos.forks.list('user-name', 'repo-name')
+    #   github.repos.forks.list('user-name', 'repo-name') { |fork|
+    #     #...
+    #   }
     #
     # @api public
     def list(*args)
diff --git a/lib/github_api/request.rb b/lib/github_api/request.rb
@@ -43,8 +43,7 @@ def initialize(action, path, api)
 
     # Performs a request
     #
-    # @param [Symbol] method - The Symbol the HTTP verb
-    # @param [String] path   - String relative URL to access
+    # @param current_options [Hash]
     # @param [ParamsHash] params - ParamsHash to configure the request API
     #
     # @return [Github::ResponseWrapper]

Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ def filter_callbacks(kind, action_name)`
`229`	`229`
`230`	`230`	`# Run all callbacks associated with this action`
`231`	`231`	`#`
`232`		`- # @apram [Symbol] action_name`
	`232`	`+ # @param [Symbol] action_name`
`233`	`233`	`#`
`234`	`234`	`# @api private`
`235`	`235`	`def run_callbacks(action_name, &block)`
Original file line number	Diff line number	Diff line change
`@@ -66,8 +66,8 @@ def get(*args)`
`66`	`66`	`# github.projects.cards.create :column_id, note: 'Card Note'`
`67`	`67`	`#`
`68`	`68`	`# @example`
`69`		`- # github = Github.new`
`70`		`- # github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'`
	`69`	`+ # github = Github.new`
	`70`	`+ # github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'`
`71`	`71`	`#`
`72`	`72`	`# @see https://developer.github.com/v3/projects/cards/#create-a-project-card`
`73`	`73`	`#`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,10 @@ class Client::Repos::Forks < API`
`13`	`13`	`#`
`14`	`14`	`# @example`
`15`	`15`	`# github = Github.new`
`16`		`- # github.repos.forks.list 'user-name', 'repo-name'`
`17`		`- # github.repos.forks.list 'user-name', 'repo-name' { \|fork\| ... }`
	`16`	`+ # github.repos.forks.list('user-name', 'repo-name')`
	`17`	`+ # github.repos.forks.list('user-name', 'repo-name') { \|fork\|`
	`18`	`+ # #...`
	`19`	`+ # }`
`18`	`20`	`#`
`19`	`21`	`# @api public`
`20`	`22`	`def list(*args)`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,7 @@ def initialize(action, path, api)`
`43`	`43`
`44`	`44`	`# Performs a request`
`45`	`45`	`#`
`46`		`- # @param [Symbol] method - The Symbol the HTTP verb`
`47`		`- # @param [String] path - String relative URL to access`
	`46`	`+ # @param current_options [Hash]`
`48`	`47`	`# @param [ParamsHash] params - ParamsHash to configure the request API`
`49`	`48`	`#`
`50`	`49`	`# @return [Github::ResponseWrapper]`