octokit 2.0.0.rc4 → 2.0.0

data/lib/octokit/client/authorizations.rb

@@ -6,13 +6,13 @@ module Octokit
     # @see http://developer.github.com/v3/oauth/#oauth-authorizations-api
     module Authorizations
 
-      # List a users authorizations
+      # List the authenticated user's authorizations
       #
       # API for users to manage their own tokens.
       # You can only access your own tokens, and only through
       # Basic Authentication.
       #
-      # @return [Array] A list of authorizations for the authenticated user
+      # @return [Array<Sawyer::Resource>] A list of authorizations for the authenticated user
       # @see http://developer.github.com/v3/oauth/#list-your-authorizations
       # @example List authorizations for user ctshryock
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
@@ -27,7 +27,7 @@ module Octokit
       # You can only access your own tokens, and only through
       # Basic Authentication.
       #
-      # @return [Authorization] A single authorization for the authenticated user
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
       # @see http://developer.github.com/v3/oauth/#get-a-single-authorization
       # @example Show authorization for user ctshryock's Travis auth
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
@@ -43,11 +43,11 @@ module Octokit
       #
       # @param options [Hash] A customizable set of options.
       # @option options [Array] :scopes A list of scopes that this authorization is in.
-      #   See http://developer.github.com/v3/oauth/#scopes for available scopes
       # @option options [String] :note A note to remind you what the OAuth token is for.
       # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
       #
-      # @return [Authorization] A single authorization for the authenticated user
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see http://developer.github.com/v3/oauth/#scopes Available scopes
       # @see http://developer.github.com/v3/oauth/#create-a-new-authorization
       # @example Create a new authorization for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
@@ -70,7 +70,7 @@ module Octokit
       # @option options [String] :note A note to remind you what the OAuth token is for.
       # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
       #
-      # @return [Authorization] A single (updated) authorization for the authenticated user
+      # @return [Sawyer::Resource] A single (updated) authorization for the authenticated user
       # @see http://developer.github.com/v3/oauth/#update-a-new-authorization
       # @see http://developer.github.com/v3/oauth/#scopes for available scopes
       # @example Update the authorization for user ctshryock's project Zoidberg

data/lib/octokit/client/commits.rb

@@ -45,7 +45,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
       # @see http://developer.github.com/v3/repos/commits/
       # @example
-      #   Octokit.commits_since('pengwynn/octokit', '2012-10-01')
+      #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
       def commits_since(*args)
         arguments = Octokit::RepoArguments.new(args)
         date   = parse_date(arguments.shift)
@@ -72,7 +72,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
       # @see http://developer.github.com/v3/repos/commits/
       # @example
-      #   Octokit.commits_before('pengwynn/octokit', '2012-10-01')
+      #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
       def commits_before(*args)
         arguments = Octokit::RepoArguments.new(args)
         date   = parse_date(arguments.shift)
@@ -99,7 +99,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
       # @see http://developer.github.com/v3/repos/commits/
       # @example
-      #   Octokit.commits_on('pengwynn/octokit', '2012-10-01')
+      #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01')
       def commits_on(*args)
         arguments = Octokit::RepoArguments.new(args)
         date   = parse_date(arguments.shift)
@@ -128,7 +128,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
       # @see http://developer.github.com/v3/repos/commits/
       # @example
-      #   Octokit.commits_on('pengwynn/octokit', '2012-10-01', '2012-11-01')
+      #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
         arguments = Octokit::RepoArguments.new(args)
         date       = parse_date(arguments.shift)

data/lib/octokit/client/contents.rb

@@ -15,7 +15,7 @@ module Octokit
       # @return [Sawyer::Resource] The detail of the readme
       # @see http://developer.github.com/v3/repos/contents/
       # @example Get the readme file for a repo
-      #   Octokit.readme("pengwynn/octokit")
+      #   Octokit.readme("octokit/octokit.rb")
       def readme(repo, options={})
         get "repos/#{Repository.new repo}/readme", options
       end
@@ -28,7 +28,7 @@ module Octokit
       # @return [Sawyer::Resource] The contents of a file or list of the files in the folder
       # @see http://developer.github.com/v3/repos/contents/
       # @example List the contents of lib/octokit.rb
-      #   Octokit.contents("pengwynn/octokit", :path => 'lib/octokit.rb')
+      #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
       def contents(repo, options={})
         repo_path = options.delete :path
         url = "repos/#{Repository.new repo}/contents/#{repo_path}"
@@ -48,7 +48,7 @@ module Octokit
       # @return [Sawyer::Resource] The contents and commit info for the addition
       # @see http://developer.github.com/v3/repos/contents/#create-a-file
       # @example Add content at lib/octokit.rb
-      #   Octokit.create_contents("pengwynn/octokit",
+      #   Octokit.create_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
       #                    "Adding content",
       #                    "asdf9as0df9asdf8as0d9f8==...",
@@ -95,7 +95,7 @@ module Octokit
       # @return [Sawyer::Resource] The contents and commit info for the update
       # @see http://developer.github.com/v3/repos/contents/#update-a-file
       # @example Update content at lib/octokit.rb
-      #   Octokit.update_contents("pengwynn/octokit",
+      #   Octokit.update_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
       #                    "Updating content",
       #                    "7eb95f97e1a0636015df3837478d3f15184a5f49",
@@ -123,7 +123,7 @@ module Octokit
       # @return [Sawyer::Resource] The commit info for the delete
       # @see http://developer.github.com/v3/repos/contents/#delete-a-file
       # @example Delete content at lib/octokit.rb
-      #   Octokit.delete_contents("pengwynn/octokit",
+      #   Octokit.delete_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
       #                    "Deleting content",
       #                    "7eb95f97e1a0636015df3837478d3f15184a5f49",
@@ -145,8 +145,8 @@ module Octokit
       # @option options [String] :ref Optional valid Git reference, defaults to master.
       # @return [String] Location of the download
       # @see http://developer.github.com/v3/repos/contents/
-      # @example Get archive link for pengwynn/octokit
-      #   Octokit.archive_link("pengwynn/octokit")
+      # @example Get archive link for octokit/octokit.rb
+      #   Octokit.archive_link("octokit/octokit.rb")
       def archive_link(repo, options={})
         repo_ref = options.delete :ref
         format = (options.delete :format) || 'tarball'

data/lib/octokit/client/events.rb

@@ -110,7 +110,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] Array of all Issue Events for this Repository
       # @see http://developer.github.com/v3/issues/events/#list-events-for-a-repository
       # @example Get all Issue Events for Octokit
-      #   Octokit.repository_issue_events("pengwynn/octokit")
+      #   Octokit.repository_issue_events("octokit/octokit.rb")
       def repository_issue_events(repo, options = {})
         paginate "repos/#{Repository.new repo}/issues/events", options
       end
@@ -123,8 +123,8 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] Array of events for that issue
       # @see http://developer.github.com/v3/issues/events/#list-events-for-an-issue
-      # @example List all issues events for issue #38 on pengwynn/octokit
-      #   Octokit.issue_events("pengwynn/octokit", 38)
+      # @example List all issues events for issue #38 on octokit/octokit.rb
+      #   Octokit.issue_events("octokit/octokit.rb", 38)
       def issue_events(repo, number, options = {})
         paginate "repos/#{Repository.new(repo)}/issues/#{number}/events", options
       end
@@ -137,7 +137,7 @@ module Octokit
       # @return [Sawyer::Resource] A single Event for an Issue
       # @see http://developer.github.com/v3/issues/events/#get-a-single-event
       # @example Get Event information for ID 3094334 (a pull request was closed)
-      #   Octokit.issue_event("pengwynn/octokit", 3094334)
+      #   Octokit.issue_event("octokit/octokit.rb", 3094334)
       def issue_event(repo, number, options = {})
         paginate "repos/#{Repository.new(repo)}/issues/events/#{number}", options
       end

data/lib/octokit/client/issues.rb

@@ -106,8 +106,8 @@ module Octokit
       # @param number [String] Number ID of the issue
       # @return [Sawyer::Resource] The issue you requested, if it exists
       # @see http://developer.github.com/v3/issues/#get-a-single-issue
-      # @example Get issue #25 from pengwynn/octokit
-      #   Octokit.issue("pengwynn/octokit", "25")
+      # @example Get issue #25 from octokit/octokit.rb
+      #   Octokit.issue("octokit/octokit.rb", "25")
       def issue(repo, number, options = {})
         get "repos/#{Repository.new(repo)}/issues/#{number}", options
       end
@@ -122,8 +122,8 @@ module Octokit
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Sawyer::Resource] The updated Issue
       # @see http://developer.github.com/v3/issues/#edit-an-issue
-      # @example Close Issue #25 from pengwynn/octokit
-      #   Octokit.close_issue("pengwynn/octokit", "25")
+      # @example Close Issue #25 from octokit/octokit.rb
+      #   Octokit.close_issue("octokit/octokit.rb", "25")
       def close_issue(repo, number, options = {})
         patch "repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"})
       end
@@ -138,8 +138,8 @@ module Octokit
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Sawyer::Resource] The updated Issue
       # @see http://developer.github.com/v3/issues/#edit-an-issue
-      # @example Reopen Issue #25 from pengwynn/octokit
-      #   Octokit.reopen_issue("pengwynn/octokit", "25")
+      # @example Reopen Issue #25 from octokit/octokit.rb
+      #   Octokit.reopen_issue("octokit/octokit.rb", "25")
       def reopen_issue(repo, number, options = {})
         patch "repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"})
       end
@@ -158,7 +158,7 @@ module Octokit
       # @return [Sawyer::Resource] The updated Issue
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @example Change the title of Issue #25
-      #   Octokit.update_issue("pengwynn/octokit", "25", "A new title", "the same body"")
+      #   Octokit.update_issue("octokit/octokit.rb", "25", "A new title", "the same body"")
       def update_issue(repo, number, title, body, options = {})
         patch "repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body})
       end
@@ -180,10 +180,10 @@ module Octokit
       # @see http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
       #
       # @example Get the comments for issues in the octokit repository
-      #   @client.issues_comments("pengwynn/octokit")
+      #   @client.issues_comments("octokit/octokit.rb")
       #
       # @example Get issues comments, sort by updated descending since a time
-      #   @client.issues_comments("pengwynn/octokit", {
+      #   @client.issues_comments("octokit/octokit.rb", {
       #     :sort => 'desc',
       #     :direction => 'asc',
       #     :since => '2010-05-04T23:45:02Z'
@@ -198,8 +198,8 @@ module Octokit
       # @param number [String] Number ID of the issue
       # @return [Array<Sawyer::Resource>] Array of comments that belong to an issue
       # @see http://developer.github.com/v3/issues/comments
-      # @example Get comments for issue #25 from pengwynn/octokit
-      #   Octokit.issue_comments("pengwynn/octokit", "25")
+      # @example Get comments for issue #25 from octokit/octokit.rb
+      #   Octokit.issue_comments("octokit/octokit.rb", "25")
       def issue_comments(repo, number, options = {})
         paginate "repos/#{Repository.new(repo)}/issues/#{number}/comments", options
       end
@@ -210,8 +210,8 @@ module Octokit
       # @param number [String] Number ID of the comment
       # @return [Sawyer::Resource] The specific comment in question
       # @see http://developer.github.com/v3/issues/comments/#get-a-single-comment
-      # @example Get comment #1194549 from an issue on pengwynn/octokit
-      #   Octokit.issue_comments("pengwynn/octokit", 1194549)
+      # @example Get comment #1194549 from an issue on octokit/octokit.rb
+      #   Octokit.issue_comments("octokit/octokit.rb", 1194549)
       def issue_comment(repo, number, options = {})
         paginate "repos/#{Repository.new(repo)}/issues/comments/#{number}", options
       end
@@ -223,8 +223,8 @@ module Octokit
       # @param comment [String] Comment to be added
       # @return [Sawyer::Resource] Comment
       # @see http://developer.github.com/v3/issues/comments/#create-a-comment
-      # @example Add the comment "Almost to v1" to Issue #23 on pengwynn/octokit
-      #   Octokit.add_comment("pengwynn/octokit", 23, "Almost to v1")
+      # @example Add the comment "Almost to v1" to Issue #23 on octokit/octokit.rb
+      #   Octokit.add_comment("octokit/octokit.rb", 23, "Almost to v1")
       def add_comment(repo, number, comment, options = {})
         post "repos/#{Repository.new(repo)}/issues/#{number}/comments", options.merge({:body => comment})
       end
@@ -236,8 +236,8 @@ module Octokit
       # @param comment [String] Body of the comment which will replace the existing body.
       # @return [Sawyer::Resource] Comment
       # @see http://developer.github.com/v3/issues/comments/#edit-a-comment
-      # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on pengwynn/octokit
-      #   Octokit.update_comment("pengwynn/octokit", 1194549, "Almost to v1, added this on my fork")
+      # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on octokit/octokit.rb
+      #   Octokit.update_comment("octokit/octokit.rb", 1194549, "Almost to v1, added this on my fork")
       def update_comment(repo, number, comment, options = {})
         patch "repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment})
       end
@@ -248,8 +248,8 @@ module Octokit
       # @param number [Integer] Comment number
       # @return [Boolean] Success
       # @see http://developer.github.com/v3/issues/comments/#delete-a-comment
-      # @example Delete the comment #1194549 on an issue on pengwynn/octokit
-      #   Octokit.delete_comment("pengwynn/octokit", 1194549)
+      # @example Delete the comment #1194549 on an issue on octokit/octokit.rb
+      #   Octokit.delete_comment("octokit/octokit.rb", 1194549)
       def delete_comment(repo, number, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options
       end

data/lib/octokit/client/labels.rb

@@ -13,8 +13,8 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of the labels across the repository
       # @see http://developer.github.com/v3/issues/labels/
-      # @example List labels for pengwynn/octokit
-      #   Octokit.labels("pengwynn/octokit")
+      # @example List labels for octokit/octokit.rb
+      #   Octokit.labels("octokit/octokit.rb")
       def labels(repo, options = {})
         get "repos/#{Repository.new(repo)}/labels", options
       end
@@ -25,8 +25,8 @@ module Octokit
       # @param name [String] Name of the label
       # @return [Sawyer::Resource] A single label from the repository
       # @see http://developer.github.com/v3/issues/labels/#get-a-single-label
-      # @example Get the "V3 Addition" label from pengwynn/octokit
-      #   Octokit.labels("pengwynn/octokit")
+      # @example Get the "V3 Addition" label from octokit/octokit.rb
+      #   Octokit.labels("octokit/octokit.rb")
       def label(repo, name, options = {})
         get "repos/#{Repository.new(repo)}/labels/#{CGI.escape(name)}", options
       end
@@ -39,7 +39,7 @@ module Octokit
       # @return [Sawyer::Resource] The new label
       # @see http://developer.github.com/v3/issues/labels/
       # @example Add a new label "Version 1.0" with color "#cccccc"
-      #   Octokit.add_label("pengwynn/octokit", "Version 1.0", "cccccc")
+      #   Octokit.add_label("octokit/octokit.rb", "Version 1.0", "cccccc")
       def add_label(repo, label, color="ffffff", options = {})
         post "repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color})
       end
@@ -54,7 +54,7 @@ module Octokit
       # @return [Sawyer::Resource] The updated label
       # @see http://developer.github.com/v3/issues/labels/#update-a-label
       # @example Update the label "Version 1.0" with new color "#cceeaa"
-      #   Octokit.update_label("pengwynn/octokit", "Version 1.0", {:color => "cceeaa"})
+      #   Octokit.update_label("octokit/octokit.rb", "Version 1.0", {:color => "cceeaa"})
       def update_label(repo, label, options = {})
         patch "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options
       end
@@ -67,9 +67,8 @@ module Octokit
       # @param label [String] String name of the label
       # @return [Boolean] Success
       # @see http://developer.github.com/v3/issues/labels/#delete-a-label
-      # @see http://rubydoc.info/gems/faraday/0.5.3/Faraday/Response
       # @example Delete the label "Version 1.0" from the repository.
-      #   Octokit.delete_label!("pengwynn/octokit", "Version 1.0")
+      #   Octokit.delete_label!("octokit/octokit.rb", "Version 1.0")
       def delete_label!(repo, label, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options
       end
@@ -82,10 +81,9 @@ module Octokit
       # @param number [String] Number ID of the issue
       # @param label [String] String name of the label
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
-      # @see http://rubydoc.info/gems/faraday/0.5.3/Faraday/Response
       # @see http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
       # @example Remove the label "Version 1.0" from the repository.
-      #   Octokit.remove_label("pengwynn/octokit", 23, "Version 1.0")
+      #   Octokit.remove_label("octokit/octokit.rb", 23, "Version 1.0")
       def remove_label(repo, number, label, options = {})
         delete "repos/#{Repository.new(repo)}/issues/#{number}/labels/#{CGI.escape(label)}", options
       end
@@ -99,7 +97,7 @@ module Octokit
       # @return [Boolean] Success of operation
       # @see http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
       # @example Remove all labels from Issue #23
-      #   Octokit.remove_all_labels("pengwynn/octokit", 23)
+      #   Octokit.remove_all_labels("octokit/octokit.rb", 23)
       def remove_all_labels(repo, number, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/issues/#{number}/labels", options
       end
@@ -110,8 +108,8 @@ module Octokit
       # @param number [String] Number ID of the issue
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
-      # @example List labels for pengwynn/octokit
-      #   Octokit.labels("pengwynn/octokit")
+      # @example List labels for octokit/octokit.rb
+      #   Octokit.labels("octokit/octokit.rb")
       def labels_for_issue(repo, number, options = {})
         get "repos/#{Repository.new(repo)}/issues/#{number}/labels", options
       end
@@ -123,8 +121,8 @@ module Octokit
       # @param labels [Array] An array of labels to apply to this Issue
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
-      # @example Add two labels for pengwynn/octokit
-      #   Octokit.add_labels_to_an_issue("pengwynn/octokit", 10, ['V3 Transition', 'Improvement'])
+      # @example Add two labels for octokit/octokit.rb
+      #   Octokit.add_labels_to_an_issue("octokit/octokit.rb", 10, ['V3 Transition', 'Improvement'])
       def add_labels_to_an_issue(repo, number, labels)
         post "repos/#{Repository.new(repo)}/issues/#{number}/labels", labels
       end
@@ -136,8 +134,8 @@ module Octokit
       # @param labels [Array] An array of labels to use as replacement
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
-      # @example Replace labels for pengwynn/octokit Issue #10
-      #   Octokit.replace_all_labels("pengwynn/octokit", 10, ['V3 Transition', 'Improvement'])
+      # @example Replace labels for octokit/octokit.rb Issue #10
+      #   Octokit.replace_all_labels("octokit/octokit.rb", 10, ['V3 Transition', 'Improvement'])
       def replace_all_labels(repo, number, labels, options = {})
         put "repos/#{Repository.new(repo)}/issues/#{number}/labels", labels
       end
@@ -148,8 +146,8 @@ module Octokit
       # @param number [String] Number ID of the milestone
       # @return [Array<Sawyer::Resource>] A list of the labels across the milestone
       # @see  http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
-      # @example List all labels for milestone #2 on pengwynn/octokit
-      #   Octokit.labels_for_milestone("pengwynn/octokit", 2)
+      # @example List all labels for milestone #2 on octokit/octokit.rb
+      #   Octokit.labels_for_milestone("octokit/octokit.rb", 2)
       def labels_for_milestone(repo, number, options = {})
         get "repos/#{Repository.new(repo)}/milestones/#{number}/labels", options
       end

data/lib/octokit/client/markdown.rb

@@ -14,7 +14,7 @@ module Octokit
       # @return [String] HTML renderization
       # @see http://developer.github.com/v3/repos/markdown/
       # @example Render some GFM
-      #   Octokit.markdown('Fixed in #111', :mode => "gfm", :context => "pengwynn/octokit")
+      #   Octokit.markdown('Fixed in #111', :mode => "gfm", :context => "octokit/octokit.rb")
       def markdown(text, options = {})
         options[:text] = text
         options[:repo] = Repository.new(options[:repo]) if options[:repo]

data/lib/octokit/client/milestones.rb

@@ -17,7 +17,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of milestones for a repository.
       # @see http://developer.github.com/v3/issues/milestones/#List-Milestones-for-an-Issue
       # @example List milestones for a repository
-      #   Octokit.list_milestones("pengwynn/octokit")
+      #   Octokit.list_milestones("octokit/octokit.rb")
       def list_milestones(repository, options = {})
         paginate "repos/#{Repository.new(repository)}/milestones", options
       end
@@ -34,7 +34,7 @@ module Octokit
       # @return [Sawyer::Resource] A single milestone from a repository.
       # @see http://developer.github.com/v3/issues/milestones/#get-a-single-milestone
       # @example Get a single milestone for a repository
-      #   Octokit.milestone("pengwynn/octokit", 1)
+      #   Octokit.milestone("octokit/octokit.rb", 1)
       def milestone(repository, number, options = {})
         get "repos/#{Repository.new(repository)}/milestones/#{number}", options
       end
@@ -50,7 +50,7 @@ module Octokit
       # @return [Sawyer::Resource] A single milestone object
       # @see http://developer.github.com/v3/issues/milestones/#create-a-milestone
       # @example Create a milestone for a repository
-      #   Octokit.create_milestone("pengwynn/octokit", "0.7.0", {:description => 'Add support for v3 of Github API'})
+      #   Octokit.create_milestone("octokit/octokit.rb", "0.7.0", {:description => 'Add support for v3 of Github API'})
       def create_milestone(repository, title, options = {})
         post "repos/#{Repository.new(repository)}/milestones", options.merge({:title => title})
       end
@@ -67,7 +67,7 @@ module Octokit
       # @return [Sawyer::Resource] A single milestone object
       # @see http://developer.github.com/v3/issues/milestones/#update-a-milestone
       # @example Update a milestone for a repository
-      #   Octokit.update_milestone("pengwynn/octokit", 1, {:description => 'Add support for v3 of Github API'})
+      #   Octokit.update_milestone("octokit/octokit.rb", 1, {:description => 'Add support for v3 of Github API'})
       def update_milestone(repository, number, options = {})
         patch "repos/#{Repository.new(repository)}/milestones/#{number}", options
       end
@@ -81,7 +81,7 @@ module Octokit
       # @return [Boolean] Success
       # @see http://developer.github.com/v3/issues/milestones/#delete-a-milestone
       # @example Delete a single milestone from a repository
-      #   Octokit.delete_milestone("pengwynn/octokit", 1)
+      #   Octokit.delete_milestone("octokit/octokit.rb", 1)
       def delete_milestone(repository, number, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repository)}/milestones/#{number}", options
       end

data/lib/octokit/client/notifications.rb

@@ -41,9 +41,9 @@ module Octokit
       #   the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
       # @return [Array<Sawyer::Resource>] Array of notifications.
       # @see http://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository
-      # @example Get your notifications for pengwynn/octokit
-      #   @client.repository_notifications('pengwynn/octokit')
-      # @example Get your notifications for pengwynn/octokit since a time.
+      # @example Get your notifications for octokit/octokit.rb
+      #   @client.repository_notifications('octokit/octokit.rb')
+      # @example Get your notifications for octokit/octokit.rb since a time.
       #   @client.repository_notifications({since: '2012-10-09T23:39:01Z'})
       def repository_notifications(repo, options = {})
         paginate "repos/#{Repository.new repo}/notifications", options
@@ -85,7 +85,7 @@ module Octokit
       # @return [Boolean] True if marked as read, false otherwise
       # @see http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository
       # @example
-      #   @client.mark_notifications_as_read("pengwynn/octokit")
+      #   @client.mark_notifications_as_read("octokit/octokit.rb")
       def mark_repository_notifications_as_read(repo, options = {})
         request :put, "repos/#{Repository.new repo}/notifications", options