Add basic docstrings to _ProgramWithInput

mwilliamson · Sep 15, 2020 · 5784d2b · 5784d2b
1 parent e3a7dc7
commit 5784d2b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/jq.pyx b/jq.pyx
@@ -342,10 +342,18 @@ cdef class _Program(object):
 
 
 cdef class _ProgramWithInput(object):
+    """Input-supplied program"""
     cdef _JqStatePool _jq_state_pool
     cdef object _bytes_input
 
     def __cinit__(self, jq_state_pool, bytes_input):
+        """
+        Initialize the input-supplied program.
+
+        Args:
+            jq_state_pool:  The JQ state pool to acquire program state from.
+            bytes_input:    The bytes containing input JSON.
+        """
         self._jq_state_pool = jq_state_pool
         self._bytes_input = bytes_input