Skip to content

Commit 61826be

Browse files
colby-swandalehsbt
authored andcommitted
Merge pull request #9372 from RubyElders/rename-compact-api
Unify Compact Index API naming. (cherry picked from commit 9bb8f15)
1 parent 5e82739 commit 61826be

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

lib/rubygems/resolver/api_set.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# frozen_string_literal: true
22

33
##
4-
# The global rubygems pool, available via the rubygems.org API.
4+
# The global rubygems pool, available via the Compact Index API.
55
# Returns instances of APISpecification.
66

77
class Gem::Resolver::APISet < Gem::Resolver::Set
88
autoload :GemParser, File.expand_path("api_set/gem_parser", __dir__)
99

1010
##
11-
# The URI for the dependency API this APISet uses.
11+
# The URI for the Compact Index API this APISet uses.
1212

1313
attr_reader :dep_uri # :nodoc:
1414

@@ -23,9 +23,9 @@ class Gem::Resolver::APISet < Gem::Resolver::Set
2323
attr_reader :uri
2424

2525
##
26-
# Creates a new APISet that will retrieve gems from +uri+ using the RubyGems
27-
# API URL +dep_uri+ which is described at
28-
# https://guides.rubygems.org/rubygems-org-api
26+
# Creates a new APISet that will retrieve gems from +uri+ using the Compact
27+
# Index API URL +dep_uri+ which is described at
28+
# https://guides.rubygems.org/rubygems-org-compact-index-api
2929

3030
def initialize(dep_uri = "https://index.rubygems.org/info/")
3131
super()

lib/rubygems/resolver/api_specification.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# frozen_string_literal: true
22

33
##
4-
# Represents a specification retrieved via the rubygems.org API.
4+
# Represents a specification retrieved via the Compact Index API.
55
#
66
# This is used to avoid loading the full Specification object when all we need
77
# is the name, version, and dependencies.
@@ -19,10 +19,10 @@ def self.new(set, api_data)
1919
end
2020

2121
##
22-
# Creates an APISpecification for the given +set+ from the rubygems.org
22+
# Creates an APISpecification for the given +set+ from the Compact Index API
2323
# +api_data+.
2424
#
25-
# See https://guides.rubygems.org/rubygems-org-api/#misc-methods for the
25+
# See https://guides.rubygems.org/rubygems-org-compact-index-api for the
2626
# format of the +api_data+.
2727

2828
def initialize(set, api_data)

lib/rubygems/source.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# A Source knows how to list and fetch gems from a RubyGems marshal index.
66
#
77
# There are other Source subclasses for installed gems, local gems, the
8-
# bundler dependency API and so-forth.
8+
# Compact Index API and so-forth.
99

1010
class Gem::Source
1111
include Comparable

0 commit comments

Comments
 (0)