Skip to content

Commit 075aafc

Browse files
committed
Aliases should be excluded from required documentation coverage.
1 parent 6f1d04f commit 075aafc

File tree

4 files changed

+13
-2
lines changed

4 files changed

+13
-2
lines changed

bake/decode/index.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def coverage(root)
2222
public_definition = node.values.nil?
2323

2424
node.values&.each do |definition|
25-
if definition.public?
25+
if definition.coverage_relevant?
2626
level = path.size
2727

2828
if definition.documented?

context/coverage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ def coverage_percentage(root)
254254
255255
index.trie.traverse do |path, node, descend|
256256
node.values&.each do |definition|
257-
if definition.public?
257+
if definition.coverage_relevant?
258258
total += 1
259259
documented += 1 if definition.comments&.any?
260260
end

lib/decode/definition.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ def public?
8282
true
8383
end
8484

85+
# @returns [bool] If the definition should be counted in coverage metrics.
86+
def coverage_relevant?
87+
self.public?
88+
end
89+
8590
# Whether the definition has documentation.
8691
# @returns [bool] True if the definition has non-empty comments.
8792
def documented?

lib/decode/language/ruby/alias.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ def initialize(new_name, old_name, **options)
2121

2222
attr :old_name
2323

24+
# Aliases don't require separate documentation as they reference existing methods.
25+
# @returns [bool] Always false for aliases.
26+
def coverage_relevant?
27+
false
28+
end
29+
2430
# Generate a short form representation of the alias.
2531
def short_form
2632
"alias #{self.name} #{@old_name}"

0 commit comments

Comments
 (0)