LGVISIUM-89: Improved clipping behavior documentation

[dcleres]

I clarified the clipping behavior via tests and documented them in the ticket JIRA. I also clarified how I generated the test documents. The OpenAPI endpoints were also clarified so that users are aware of the data extraction behavior when using the bounding boxes to extract coordinates, number or text.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/stratigraphy
__init__.py	8	1	88%	11
extract.py	192	192	0%	3–477
get_files.py	19	19	0%	3–47
main.py	119	119	0%	3–314
src/stratigraphy/benchmark
ground_truth.py	21	1	95%	47
src/stratigraphy/data_extractor
data_extractor.py	57	3	95%	33, 66, 103
src/stratigraphy/depthcolumn
boundarydepthcolumnvalidator.py	41	20	51%	47, 57, 60, 81–84, 110–128, 140–149
depthcolumn.py	223	80	64%	25, 29, 50, 67, 72, 78, 86–92, 113, 116, 124–125, 141–143, 150, 157, 165–166, 176, 193–209, 247, 255–256, 272–274, 312, 331–339, 350, 355, 362, 393, 398–405, 420–421, 464–506
depthcolumnentry.py	36	10	72%	17, 21, 37, 52, 55, 72, 81, 98–100
find_depth_columns.py	106	19	82%	42–43, 73, 86, 180–181, 225–245
src/stratigraphy/depths_materials_column_pairs
depths_materials_column_pairs.py	18	6	67%	23, 34, 55–59
src/stratigraphy/evaluation
evaluation_dataclasses.py	49	16	67%	24, 33, 42–44, 52, 71–74, 90, 104, 125–131, 137
metadata_evaluator.py	38	14	63%	52–71, 94–101
src/stratigraphy/groundwater
groundwater_extraction.py	147	98	33%	44, 52, 83, 98, 106, 125, 152–156, 171–191, 202–291, 307–339
utility.py	39	33	15%	10–17, 30–47, 59–73, 88–102
src/stratigraphy/layer
layer.py	37	18	51%	29, 39, 57–94, 106–107
layer_identifier_column.py	74	52	30%	16–17, 20, 28, 43, 47, 51, 59–63, 66, 74, 91–96, 99, 112, 125–126, 148–158, 172–199
src/stratigraphy/lines
geometric_line_utilities.py	86	2	98%	81, 131
line.py	51	4	92%	25, 50, 60, 110
linesquadtree.py	46	1	98%	75
src/stratigraphy/metadata
coordinate_extraction.py	108	5	95%	30, 64, 94–95, 107
elevation_extraction.py	79	52	34%	34, 42, 50, 66–69, 106–120, 132–135, 147–179, 194–202, 210–214
language_detection.py	18	13	28%	17–23, 37–45
metadata.py	66	24	64%	27, 83, 101–127, 146–155, 195–198, 206
src/stratigraphy/text
description_block_splitter.py	70	2	97%	24, 139
extract_text.py	29	3	90%	19, 53–54
find_description.py	64	28	56%	27–35, 50–63, 79–95, 172–175
textblock.py	80	9	89%	28, 56, 64, 89, 101, 124, 145, 154, 183
src/stratigraphy/util
dataclasses.py	32	3	91%	37–39
interval.py	104	55	47%	29–32, 37–40, 46, 52, 56, 66–68, 107–153, 174, 180–196
predictions.py	105	41	61%	74–78, 86–94, 171–203, 242, 265–283
util.py	39	17	56%	41, 69–76, 90–92, 116–117, 129–133
TOTAL	2207	960	57%

Tests	Skipped	Failures	Errors	Time
89	0 💤	0 ❌	0 🔥	8.414s ⏱️

[stijnvermeeren-swisstopo]

Can we get Swagger UI to display the all of attribute documentation in regular font (as is the case for y0 thanks to the redundant quotes) instead of this purple monospace font?

[dcleres]

@stijnvermeeren-swisstopo I managed to address all your comments and to fix the formatting issue in the OpenAI docs (see above). Thank you, for your feedback. I do believe this improved the usability for the API users!

[stijnvermeeren-swisstopo]

I added three minor fixes. Now everything looks good to me!