Rename truncate posts arg

src/npf_renderer/format/base.py

@@ -30,7 +30,7 @@ class HTMLTimeTag(dominate.tags.html_tag):
 
 
 class Formatter(helpers.CursorIterator):
-    def __init__(self, content, layout=None, *, url_handler=None, forbid_external_iframes=False, truncate_posts=True):
+    def __init__(self, content, layout=None, *, url_handler=None, forbid_external_iframes=False, truncate=True):
         """Initializes the parser with a list of content blocks (json objects) to parse"""
         super().__init__(content)
 
@@ -45,7 +45,7 @@ def url_handler(url):
 
         self.url_handler = url_handler
         self.forbid_external_iframes = forbid_external_iframes
-        self.truncate_posts = truncate_posts
+        self.truncate = truncate
 
         self.has_render_error = False
 
@@ -585,7 +585,7 @@ def format(self):
                         row_tag = dominate.tags.div(cls="layout-row")
 
                         if (
-                            self.truncate_posts
+                            self.truncate
                             and layout.truncate_after is not None
                             and (block_index > layout.truncate_after)
                         ):

src/npf_renderer/format_npf.py

@@ -13,7 +13,7 @@ def format_npf(
     forbid_external_iframes=False,
     pretty_html=False,
     poll_result_callback=None,
-    truncate_posts=True,
+    truncate=True,
 ):
     """Formats the given NPF blocks into HTML
 
@@ -31,6 +31,8 @@ def format_npf(
         poll_result_callback:
             A function that accepts a `poll_id` parameter to request and return
             poll results. If unset, no poll results will be fetched.
+        truncate:
+            Whether to truncate the post at the point requested by the layout data
     """
     contents = Parser(contents, poll_result_callback).parse()
     if layouts:
@@ -44,7 +46,7 @@ def format_npf(
             layouts,
             url_handler=url_handler,
             forbid_external_iframes=forbid_external_iframes,
-            truncate_posts=truncate_posts,
+            truncate=truncate,
         ).format()
 
     except exceptions.RenderErrorDisclaimerError as e:

tests/layouts/test_layout_formatting.py

@@ -5,10 +5,8 @@
 import example_layout_data as data
 
 
-def helper_function(raw, answer, contents_list=data.content_list, truncate_posts=True):
-    has_error, formatted_result = format_npf(
-        contents_list, raw["layouts"], pretty_html=True, truncate_posts=truncate_posts
-    )
+def helper_function(raw, answer, contents_list=data.content_list, truncate=True):
+    has_error, formatted_result = format_npf(contents_list, raw["layouts"], pretty_html=True, truncate=truncate)
 
     assert not has_error
 
@@ -30,7 +28,7 @@ def test_basic_layout_with_truncate_but_disabled_in_formatter_format():
     helper_function(
         data.basic_rows_layout_with_truncate_example_disabled_truncation[0],
         data.basic_rows_layout_with_truncate_example_disabled_truncation[1],
-        truncate_posts=False,
+        truncate=False,
     )
 
 
@@ -45,7 +43,7 @@ def test_basic_layout_with_truncate_at_start_but_disabled_in_formatter_format():
     helper_function(
         data.basic_rows_layout_with_truncate_at_start_example_disabled_truncation[0],
         data.basic_rows_layout_with_truncate_at_start_example_disabled_truncation[1],
-        truncate_posts=False,
+        truncate=False,
     )