From 3ee24d1cf9397b4838ccf81621fa4bb1b6e87a4a Mon Sep 17 00:00:00 2001 From: Ronny H <138828701+ron-unstructured@users.noreply.github.com> Date: Wed, 4 Oct 2023 17:48:42 -0700 Subject: [PATCH] Update description for hierarchy_depth Co-authored-by: cragwolfe --- docs/source/metadata.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/metadata.rst b/docs/source/metadata.rst index 8a8dbec3b9..dd37ce4800 100644 --- a/docs/source/metadata.rst +++ b/docs/source/metadata.rst @@ -38,7 +38,7 @@ the source file: | parent_id | Element Hierarchy (Parent ID) | `parent_id` may be used to infer where an element resides within the overall hierarchy of a document. For instance, a `NarrativeText` element may have a `Title` element as a parent (a "sub-title"), which in turn may have another `Title` element as its parent (a "title). | +-----------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | category_depth | Element Depth relative to | Category depth is the depth of an element relative to other elements of the same category. It's set by a document partitioner and enables the hierarchy post-processor to compute more accurate hierarchies. | -| | other elements of the same category | Category depth is set using native document hierarchies (e.g., h1, h2, h3 or the indentation level of a bulleted list in a word document). | +| | other elements of the same category | Category depth may be set using native document hierarchies, e.g. reflecting \

, \

, or `\

` tags within an HTML document or the indentation level of a bulleted list item in a Word document. | +-----------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | text_as_html | HTML representation of extracted tables | Only applicable to table elements. | +-----------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+