Skip to content

Commit 6b0b103

Browse files
authored
Merge pull request #2570 from ksss/set-alias
Add signatures for `Set`
2 parents f053d85 + 080ff6a commit 6b0b103

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

core/set.rbs

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,15 @@ class Set[unchecked out A]
414414
#
415415
def compare_by_identity: () -> self
416416

417+
# <!--
418+
# rdoc-file=lib/set.rb
419+
# - compare_by_identity?()
420+
# -->
421+
# Returns true if the set will compare its elements by their
422+
# identity. Also see Set#compare_by_identity.
423+
#
424+
def compare_by_identity?: () -> bool
425+
417426
# <!--
418427
# rdoc-file=lib/set.rb
419428
# - disjoint?(set)
@@ -477,6 +486,15 @@ class Set[unchecked out A]
477486
#
478487
def flatten: () -> Set[untyped]
479488

489+
# <!--
490+
# rdoc-file=lib/set.rb
491+
# - flatten!()
492+
# -->
493+
# Equivalent to Set#flatten, but replaces the receiver with the
494+
# result in place. Returns nil if no modifications were made.
495+
#
496+
def flatten!: () -> self?
497+
480498
# <!--
481499
# rdoc-file=lib/set.rb
482500
# - intersect?(set)
@@ -532,6 +550,13 @@ class Set[unchecked out A]
532550
#
533551
def subset?: (self) -> bool
534552

553+
# <!--
554+
# rdoc-file=lib/set.rb
555+
# - <=(set)
556+
# -->
557+
#
558+
alias <= subset?
559+
535560
# <!--
536561
# rdoc-file=lib/set.rb
537562
# - proper_subset?(set)
@@ -540,6 +565,13 @@ class Set[unchecked out A]
540565
#
541566
def proper_subset?: (self) -> bool
542567

568+
# <!--
569+
# rdoc-file=lib/set.rb
570+
# - <(set)
571+
# -->
572+
#
573+
alias < proper_subset?
574+
543575
# <!--
544576
# rdoc-file=lib/set.rb
545577
# - superset?(set)
@@ -548,6 +580,13 @@ class Set[unchecked out A]
548580
#
549581
def superset?: (self) -> bool
550582

583+
# <!--
584+
# rdoc-file=lib/set.rb
585+
# - >=(set)
586+
# -->
587+
#
588+
alias >= superset?
589+
551590
# <!--
552591
# rdoc-file=lib/set.rb
553592
# - proper_superset?(set)
@@ -556,6 +595,13 @@ class Set[unchecked out A]
556595
#
557596
def proper_superset?: (self) -> bool
558597

598+
# <!--
599+
# rdoc-file=lib/set.rb
600+
# - >(set)
601+
# -->
602+
#
603+
alias > proper_superset?
604+
559605
# <!--
560606
# rdoc-file=lib/set.rb
561607
# - replace(enum)
@@ -587,6 +633,11 @@ class Set[unchecked out A]
587633
#
588634
def select!: () { (A) -> untyped } -> self?
589635

636+
# <!-- rdoc-file=lib/set.rb -->
637+
# Equivalent to Set#select!
638+
#
639+
alias filter! select!
640+
590641
# <!--
591642
# rdoc-file=lib/set.rb
592643
# - subtract(enum)
@@ -605,6 +656,15 @@ class Set[unchecked out A]
605656
# Set[1, 'c', :s].to_a #=> [1, "c", :s]
606657
#
607658
def to_a: () -> Array[A]
659+
660+
# <!--
661+
# rdoc-file=lib/set.rb
662+
# - join(separator=nil)
663+
# -->
664+
# Returns a string created by converting each element of the set to a string
665+
# See also: Array#join
666+
#
667+
def join: (?string separator) -> String
608668
end
609669

610670
%a{annotate:rdoc:skip}

0 commit comments

Comments
 (0)