suggested fixes to docs

abhizer · ryzhyk · commit 9dd850d4df67 · 2024-06-24T12:04:08.000-07:00
Signed-off-by: Abhinav Gyawali &lt;22275402+abhizer@users.noreply.github.com&gt;
diff --git a/python/docs/examples.rst b/python/docs/examples.rst
@@ -5,7 +5,6 @@ Using Pandas DataFrames as Input / Output
 *******************************************
 
 
-Working wth pandas DataFrames in Feldera is fairly straight forward. 
 You can use :meth:`.SQLContext.input_pandas` to connect a
 DataFrame to a feldera table as the data source. 
 
diff --git a/python/docs/introduction.rst b/python/docs/introduction.rst
@@ -65,7 +65,7 @@ Key Concepts
       - The second parameter here is :class:`.FelderaClient` that we created above.
 
 * :meth:`.SQLContext.wait_for_completion`
-   - Blocks this Feldera pipeline until completion. Normally this means until the EoF
+   - Blocks this Feldera pipeline until completion. Normally this means until the end-of-file (EOF)
      has been reached for this input source.
 
    - Takes a parameter ``shutdown``, when set shuts the pipeline down after completion.
diff --git a/python/feldera/enums.py b/python/feldera/enums.py
@@ -7,16 +7,24 @@ class CompilationProfile(Enum):
     """
 
     SERVER_DEFAULT = None
-    "The compiler server default compilation profile."
+    """
+    The compiler server default compilation profile.
+    """
 
     DEV = "dev"
-    "The development compilation profile."
+    """
+    The development compilation profile.
+    """
 
     UNOPTIMIZED = "unoptimized"
-    "The unoptimized compilation profile."
+    """
+    The unoptimized compilation profile.
+    """
 
     OPTIMIZED = "optimized"
-    "The optimized compilation profile, the default for this API."
+    """
+    The optimized compilation profile, the default for this API.
+    """
 
 
 class BuildMode(Enum):
