Skip to content

Commit 0acaf58

Browse files
Add missing documentation.
1 parent 6868ce1 commit 0acaf58

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

lib/decode/location.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
module Decode
77
# Represents a location in a source file.
88
class Location
9+
# Initialize a new location.
10+
# @parameter path [String] The path to the source file.
11+
# @parameter line [Integer] The line number in the source file.
912
def initialize(path, line)
1013
@path = path
1114
@line = line

lib/decode/rbs/type.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
module Decode
1010
module RBS
11+
# Utilities for working with RBS types.
1112
module Type
1213
# Check if an RBS type represents a nullable/optional type
1314
# This method recursively traverses the type tree to find nil anywhere

sig/decode.rbs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -852,7 +852,8 @@ module Decode
852852

853853
@line: Integer
854854

855-
public def initialize: (untyped path, untyped line) -> void
855+
# Initialize a new location.
856+
public def initialize: (String path, Integer line) -> void
856857

857858
# Generate a string representation of the location.
858859
public def to_s: () -> untyped
@@ -994,6 +995,7 @@ module Decode
994995
private def build_attributes_rbs: (Array attribute_definitions) -> Array
995996
end
996997

998+
# Utilities for working with RBS types.
997999
module Type
9981000
# Check if an RBS type represents a nullable/optional type
9991001
# This method recursively traverses the type tree to find nil anywhere

0 commit comments

Comments
 (0)