Add function parameter comments

exercism · Nov 14, 2024 · 14f6106 · 14f6106
1 parent a511135
commit 14f6106
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 7 deletions.
diff --git a/exercises/practice/acronym/acronym.ua b/exercises/practice/acronym/acronym.ua
@@ -1 +1,3 @@
-Acronym ← |1 ⟜(⍤"Please implement the Acronym function")
+# Determine a sentence's acronym
+# Acronym ? Sentence
+Acronym ← |1 ⟜(⍤"Please implement the Acronym function")
diff --git a/exercises/practice/bob/bob.ua b/exercises/practice/bob/bob.ua
@@ -1 +1,3 @@
-HeyBob ← |1 (⍤ "Please implement HeyBob").
+# Respond to a phrase as Bob would
+# Response ? Phrase
+HeyBob ← |1 ⊙(⍤ "Please implement HeyBob" 0)
diff --git a/exercises/practice/collatz-conjecture/collatz-conjecture.ua b/exercises/practice/collatz-conjecture/collatz-conjecture.ua
@@ -1 +1,3 @@
+# Calculate the number of steps of a number using the Collatz Conjecture
+# NumberOfSteps ? Number
 Steps ← |1 ⊙(⍤ "Please implement Steps" 0)
diff --git a/exercises/practice/darts/darts.ua b/exercises/practice/darts/darts.ua
@@ -1 +1,3 @@
+# Calculate a score for a given point in a game of darts
+# Score ? X Y
 Score ← |2 ⍤"Please implement Score" ⊙⊙
diff --git a/exercises/practice/difference-of-squares/difference-of-squares.ua b/exercises/practice/difference-of-squares/difference-of-squares.ua
@@ -1,3 +1,11 @@
-SquareOfSum         ← |1 ⊙(⍤ "Please implement SquareOfSum" 0)
-SumOfSquares        ← |1 ⊙(⍤ "Please implement SumOfSquares" 0)
+# Calculate the square of the sums of the first N natural numbers
+# SquareOfSum ? Number
+SquareOfSum ← |1 ⊙(⍤ "Please implement SquareOfSum" 0)
+
+# Calculate the sum of the squares of the first N natural numbers
+# SumOfSquares ? Number
+SumOfSquares ← |1 ⊙(⍤ "Please implement SumOfSquares" 0)
+
+# Calculate the difference between the square of sums and sum of squares
+# DifferenceOfSquares ? Number
 DifferenceOfSquares ← |1 ⊙(⍤ "Please implement DifferenceOfSquares" 0)
diff --git a/exercises/practice/eliuds-eggs/eliuds-eggs.ua b/exercises/practice/eliuds-eggs/eliuds-eggs.ua
@@ -1 +1,3 @@
+# Decode the number of eggs from its encoded value
+# EggCount ? EncodedEggCount
 EggCount ← |1 ⊙(⍤ "Please implement EggCount" 0)
diff --git a/exercises/practice/hamming/hamming.ua b/exercises/practice/hamming/hamming.ua
@@ -1 +1,3 @@
+# Calculate the Hamming distance between two DNA strands
+# Distance ? Strand1 Strand1
 Distance ← |2 ⍤"Please implement Distance" ⊙⊙
diff --git a/exercises/practice/hello-world/hello-world.ua b/exercises/practice/hello-world/hello-world.ua
@@ -1 +1,2 @@
+# Say hello to the world!
 Hello ← |0 "Goodbye, Mars!"
diff --git a/exercises/practice/largest-series-product/largest-series-product.ua b/exercises/practice/largest-series-product/largest-series-product.ua
@@ -1 +1,3 @@
+# Find the largest product of a contiguous substring of digits of length N.
+# Product ? Input Span
 LargestProduct ← |2 ⊙(⍤ "Please implement LargestProduct")
diff --git a/exercises/practice/leap/leap.ua b/exercises/practice/leap/leap.ua
@@ -1,2 +1,3 @@
-Leap ← |2 ⍤"Please implement the Leap function" ⊙⊙
-
+# Determine if a year is a leap year
+# IsLeapYear ? Year
+Leap ← |1 ⊙(⍤"Please implement the Leap function" 0)
diff --git a/exercises/practice/two-fer/two-fer.ua b/exercises/practice/two-fer/two-fer.ua
@@ -1 +1,3 @@
-TwoFer ←|1 ⊙(⍤ "Please implement TwoFer" "")
+# Return the greeting message
+# Greeting | Name
+TwoFer ← |1 ⊙(⍤ "Please implement TwoFer" "")