docstring fix

Forced-Alignment-and-Vowel-Extraction · Feb 26, 2024 · 9879c21 · 9879c21
1 parent 72933ec
commit 9879c21
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/reference/syllabify.qmd b/docs/reference/syllabify.qmd
@@ -29,8 +29,12 @@ Make syllable constituents for a word interval
 `syllabify.syllabify_tg(tg)`
 
 Syllabify an entire AlignedTextGrid
-Args:
-    tg (AlignedTextGrid): The textgrid to syllabify
+
+#### Parameters
+
+| Name   | Type                             | Description               | Default    |
+|--------|----------------------------------|---------------------------|------------|
+| `tg`   | aligned_textgrid.AlignedTextGrid | The textgrid to syllabify | _required_ |
 
 ### syllabify_word { #fave_syllabify.syllabify.syllabify_word }
 

diff --git a/src/fave_syllabify/syllabify.py b/src/fave_syllabify/syllabify.py
@@ -160,6 +160,7 @@ def syllabify_word(word: SequenceInterval):
 
 def syllabify_tg(tg: AlignedTextGrid):
     """Syllabify an entire AlignedTextGrid
+    
     Args:
         tg (AlignedTextGrid): The textgrid to syllabify
     """
-Original file line number
+Diff line change
@@ Expand Up / @@ -160,6 +160,7 @@ def syllabify_word(word: SequenceInterval): @@
     def syllabify_tg(tg: AlignedTextGrid):
         """Syllabify an entire AlignedTextGrid
         Args:
             tg (AlignedTextGrid): The textgrid to syllabify
         """
@@ Expand Down @@