Merge pull request piotrmurach#228 from vfonic/patch-1

piotrmurach · piotrmurach · commit 03972d77d145 · 2015-05-12T22:44:36.000+01:00
Fix typo in readme method documentation
diff --git a/lib/github_api/client/repos/contents.rb b/lib/github_api/client/repos/contents.rb
@@ -20,7 +20,8 @@ class Client::Repos::Contents < API
     #   github = Github.new
     #   github.repos.contents.readme 'user-name', 'repo-name'
     #
-    #   content = Github::Repos;:Contents.new user: 'user-name', 'repo-name'
+    # @example
+    #   content = Github::Client::Repos::Contents.new user: 'user-name', repo: 'repo-name'
     #   content.readme
     #
     # @api public

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ class Client::Repos::Contents < API`
`20`	`20`	`# github = Github.new`
`21`	`21`	`# github.repos.contents.readme 'user-name', 'repo-name'`
`22`	`22`	`#`
`23`		`- # content = Github::Repos;:Contents.new user: 'user-name', 'repo-name'`
	`23`	`+ # @example`
	`24`	`+ # content = Github::Client::Repos::Contents.new user: 'user-name', repo: 'repo-name'`
`24`	`25`	`# content.readme`
`25`	`26`	`#`
`26`	`27`	`# @api public`