Skip to content

Commit fa0ef13

Browse files
committed
Remove def-style comments
They are mostly redundant with the method signature and don't look great when rendered. I'll add proper docs for nodes in a followup PR
1 parent 828edbd commit fa0ef13

2 files changed

Lines changed: 0 additions & 18 deletions

File tree

templates/lib/prism/dispatcher.rb.erb

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,12 @@ module Prism
4141
end
4242

4343
# Register a listener for one or more events.
44-
#
45-
# def register: (Listener, *Symbol) -> void
4644
def register(listener, *events)
4745
register_events(listener, events)
4846
end
4947

5048
# Register all public methods of a listener that match the pattern
5149
# `on_<node_name>_(enter|leave)`.
52-
#
53-
# def register_public_methods: (Listener) -> void
5450
def register_public_methods(listener)
5551
register_events(listener, listener.public_methods(false).grep(/\Aon_.+_(?:enter|leave)\z/))
5652
end
@@ -61,13 +57,9 @@ module Prism
6157
end
6258

6359
# Walks `root` dispatching events to all registered listeners.
64-
#
65-
# def dispatch: (Node) -> void
6660
alias dispatch visit
6761

6862
# Dispatches a single event for `node` to all registered listeners.
69-
#
70-
# def dispatch_once: (Node) -> void
7163
def dispatch_once(node)
7264
node.accept(DispatchOnce.new(listeners))
7365
end

templates/lib/prism/node.rb.erb

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -335,12 +335,10 @@ module Prism
335335
<%- end -%>
336336
end
337337

338-
# def accept: (Visitor visitor) -> void
339338
def accept(visitor)
340339
visitor.visit_<%= node.human %>(self)
341340
end
342341

343-
# def child_nodes: () -> Array[Node?]
344342
def child_nodes
345343
[<%= node.fields.map { |field|
346344
case field
@@ -350,7 +348,6 @@ module Prism
350348
}.compact.join(", ") %>]
351349
end
352350

353-
# def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator[Prism::node]
354351
def each_child_node
355352
return to_enum(:each_child_node) unless block_given?
356353

@@ -366,7 +363,6 @@ module Prism
366363
<%- end -%>
367364
end
368365

369-
# def compact_child_nodes: () -> Array[Node]
370366
def compact_child_nodes
371367
<%- if node.fields.any? { |field| field.is_a?(Prism::Template::OptionalNodeField) } -%>
372368
compact = [] #: Array[Prism::node]
@@ -391,7 +387,6 @@ module Prism
391387
<%- end -%>
392388
end
393389

394-
# def comment_targets: () -> Array[Node | Location]
395390
def comment_targets
396391
[<%= node.fields.map { |field|
397392
case field
@@ -401,12 +396,10 @@ module Prism
401396
}.compact.join(", ") %>] #: Array[Prism::node | Location]
402397
end
403398

404-
# def copy: (<%= (["?node_id: Integer", "?location: Location", "?flags: Integer"] + node.fields.map { |field| "?#{field.name}: #{field.rbs_class}" }).join(", ") %>) -> <%= node.name %>
405399
def copy(<%= (["node_id", "location", "flags"] + node.fields.map(&:name)).map { |field| "#{field}: self.#{field}" }.join(", ") %>)
406400
<%= node.name %>.new(<%= ["source", "node_id", "location", "flags", *node.fields.map(&:name)].join(", ") %>)
407401
end
408402

409-
# def deconstruct: () -> Array[Node?]
410403
alias deconstruct child_nodes
411404

412405
def deconstruct_keys(keys) # :nodoc:
@@ -415,7 +408,6 @@ module Prism
415408
<%- if (node_flags = node.flags) -%>
416409
<%- node_flags.values.each do |value| -%>
417410

418-
# def <%= value.name.downcase %>?: () -> bool
419411
def <%= value.name.downcase %>?
420412
flags.anybits?(<%= node_flags.name %>::<%= value.name %>)
421413
end
@@ -471,15 +463,13 @@ module Prism
471463
<%- raise unless field.name.end_with?("_loc") -%>
472464
<%- next if node.fields.any? { |other| other.name == field.name.delete_suffix("_loc") } -%>
473465

474-
# def <%= field.name.delete_suffix("_loc") %>: () -> String
475466
def <%= field.name.delete_suffix("_loc") %>
476467
<%= field.name %>.slice
477468
end
478469
<%- when Prism::Template::OptionalLocationField -%>
479470
<%- raise unless field.name.end_with?("_loc") -%>
480471
<%- next if node.fields.any? { |other| other.name == field.name.delete_suffix("_loc") } -%>
481472

482-
# def <%= field.name.delete_suffix("_loc") %>: () -> String?
483473
def <%= field.name.delete_suffix("_loc") %>
484474
<%= field.name %>&.slice
485475
end

0 commit comments

Comments
 (0)