Permalink
Browse files

Correct documentation examples to new method call.

  • Loading branch information...
1 parent e268a41 commit 98db9d07d45bd9f0718178035d30da316b2409f1 @piotrmurach committed Apr 30, 2012
Showing with 10 additions and 10 deletions.
  1. +10 −10 lib/github_api/git_data/commits.rb
@@ -28,8 +28,8 @@ def initialize(options = {})
# Get a commit
#
# = Examples
- # @github = Github.new
- # @github.git_data.commit 'user-name', 'repo-name', 'sha'
+ # github = Github.new
+ # github.git_data.commits.get 'user-name', 'repo-name', 'sha'
#
def get(user_name, repo_name, sha, params={})
_update_user_repo_params(user_name, repo_name)
@@ -52,16 +52,16 @@ def get(user_name, repo_name, sha, params={})
#
# The committer section is optional and will be filled with the author data if omitted. If the author section is omitted, it will be filled in with the authenticated users information and the current date.
#
- # * author.name:: String of the name of the author of the commit
- # * author.email:: String of the email of the author of the commit
- # * author.date:: Timestamp of when this commit was authored
- # * committer.name:: String of the name of the committer of the commit
- # * committer.email:: String of the email of the committer of the commit
- # * committer.date:: Timestamp of when this commit was committed
+ # * author.name - String of the name of the author of the commit
+ # * author.email - String of the email of the author of the commit
+ # * author.date - Timestamp of when this commit was authored
+ # * committer.name - String of the name of the committer of the commit
+ # * committer.email - String of the email of the committer of the commit
+ # * committer.date - Timestamp of when this commit was committed
#
# = Examples
- # @github = Github.new
- # @github.git_data.create_commit 'user-name', 'repo-name',
+ # github = Github.new
+ # github.git_data.commits.create 'user-name', 'repo-name',
# "message": "my commit message",
# "author": {
# "name": "Scott Chacon",

0 comments on commit 98db9d0

Please sign in to comment.