API glossary
Kinds, modifiers and package labels in the Ruby API reference. Select an annotation or full API badge to open its definition here.
The signature and entry documentation describe the API’s behavior, including its calling conventions, storage and runtime checks.
Symbol kinds#
Kinds identify declarations in the Ruby API reference.
module#
A Ruby namespace that can also supply instance methods as a mixin.
References: Ruby modules .
class#
A Ruby object type defining instance behavior and inheriting from a superclass.
References: Ruby classes .
method#
A Ruby operation called on a receiver, usually declared with def.
Instance methods act on instances; singleton methods act on a particular object, including a class object.
References: Ruby methods .
typealias#
An RBS type alias used to describe Ruby values for tooling. It does not define a runtime class.
References: RBS type aliases .
Modifiers#
Modifiers add information about calling, implementing, or accessing a declaration. Their precise effect follows the language and the signature.
static#
A Ruby class-level or module-level singleton method, called on that object.
References: Ruby singleton methods .
Package context#
Package labels identify where an API is supplied.
package#
The Ruby gem supplying this API. Gem names identify distributions; require loads Ruby files.
References: Ruby gems .