Explain why docstrings are important.

primitives/test_primitives/increment.py

@@ -28,6 +28,9 @@ class Hyperparams(hyperparams.Hyperparams):
 
 
 class IncrementPrimitive(transformer.TransformerPrimitiveBase[Inputs, Outputs, Hyperparams]):
+    # It is important to provide a docstring because this docstring is used as a description of
+    # a primitive. Some callers might analyze it to determine the nature and purpose of a primitive.
+
     """
     A primitive which increments each value by a fixed amount, by default 1.
     """

primitives/test_primitives/monomial.py

@@ -24,6 +24,9 @@ class Hyperparams(hyperparams.Hyperparams):
 
 
 class MonomialPrimitive(supervised_learning.SupervisedLearnerPrimitiveBase[Inputs, Outputs, Params, Hyperparams]):
+    # It is important to provide a docstring because this docstring is used as a description of
+    # a primitive. Some callers might analyze it to determine the nature and purpose of a primitive.
+
     """
     A primitive which fits output = a * input.
     """

primitives/test_primitives/random.py

@@ -29,6 +29,9 @@ class Hyperparams(hyperparams.Hyperparams):
 
 
 class RandomPrimitive(generator.GeneratorPrimitiveBase[Outputs, None, Hyperparams]):
+    # It is important to provide a docstring because this docstring is used as a description of
+    # a primitive. Some callers might analyze it to determine the nature and purpose of a primitive.
+
     """
     A primitive which draws random samples from a normal distribution.
     """

primitives/test_primitives/sum.py

@@ -34,6 +34,9 @@ class Hyperparams(hyperparams.Hyperparams):
 
 
 class SumPrimitive(base.SingletonOutputMixin[Inputs, Outputs, None, Hyperparams], transformer.TransformerPrimitiveBase[Inputs, Outputs, Hyperparams]):
+    # It is important to provide a docstring because this docstring is used as a description of
+    # a primitive. Some callers might analyze it to determine the nature and purpose of a primitive.
+
     """
     A primitive which sums all the values on input into one number.
     """