Improve README

sandflow · Dec 28, 2023 · 19e4da1 · 19e4da1
1 parent e08a997
commit 19e4da1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -218,6 +218,11 @@ Default: `"auto"`
 
 ### LCD filter configuration (`"lcd"`)
 
+#### Description
+
+The LCD filter merges regions and removes all text formatting with the exception
+of color and text alignment.
+
 #### safe_area
 
 `"safe_area" : <integer between 0 and 30>`
@@ -246,7 +251,15 @@ specified at <https://www.w3.org/TR/ttml2/#style-value-color>.
 
 Default: `null`
 
-Examples: `"#FF0000"` (red), `"transparent"`, `"black`
+Examples: `"#FF0000"` (red), `"transparent"`, `"black"`
+
+#### preserve_text_align
+
+`"preserve_text_align" : true | false`
+
+If `true`, text alignment is preserved, otherwise text is centered.
+
+Default: `false`
 
 ## Library
 

diff --git a/src/main/python/ttconv/filters/doc/lcd.py b/src/main/python/ttconv/filters/doc/lcd.py
@@ -82,7 +82,7 @@ def name(cls):
  # specifies the safe area as an integer percentage
  safe_area: typing.Optional[int] = field(default=10, metadata={"decoder": _safe_area_decoder})
 
- # preserve text alignment the text color
+ # preserve text alignment
  preserve_text_align: typing.Optional[bool] = field(default=False, metadata={"decoder": bool})
 
  # overrides the text color