Merge pull request #519 from yui-knk/comments_for_params

Comments for `Digraph#initialize`
ruby · Jan 21, 2025 · 7e0aee8 · 7e0aee8
2 parents 5eadda7 + 5628ee5
commit 7e0aee8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/lib/lrama/digraph.rb b/lib/lrama/digraph.rb
@@ -39,9 +39,9 @@ class Digraph
     #   @h: Hash[X, (Integer|Float)?]
     #   @result: Hash[X, Y]
 
-    # @rbs sets: Array[X]
-    # @rbs relation: Hash[X, Array[X]]
-    # @rbs base_function: Hash[X, Y]
+    # @rbs sets: Array[X] -- Nodes of graph
+    # @rbs relation: Hash[X, Array[X]] -- Edges of graph
+    # @rbs base_function: Hash[X, Y] -- Attributes of nodes
     # @rbs return: void
     def initialize(sets, relation, base_function)
 

diff --git a/sig/generated/lrama/digraph.rbs b/sig/generated/lrama/digraph.rbs
@@ -40,9 +40,9 @@ module Lrama
 
     @result: Hash[X, Y]
 
-    # @rbs sets: Array[X]
-    # @rbs relation: Hash[X, Array[X]]
-    # @rbs base_function: Hash[X, Y]
+    # @rbs sets: Array[X] -- Nodes of graph
+    # @rbs relation: Hash[X, Array[X]] -- Edges of graph
+    # @rbs base_function: Hash[X, Y] -- Attributes of nodes
     # @rbs return: void
     def initialize: (Array[X] sets, Hash[X, Array[X]] relation, Hash[X, Y] base_function) -> void