From 7a82c9b0a3e8ab3cd8251173fc18e3cb4dc429c2 Mon Sep 17 00:00:00 2001 From: Petru Conduraru Date: Sat, 25 Jul 2026 11:50:54 +0300 Subject: [PATCH] ifcpatch: correct the AGS2IFC docstring example The example block was copy pasted verbatim from ExtractPropertiesToSQLite, so it named the wrong recipe and wrote a .sqlite file. These docstrings are what ifcpatch surfaces as CLI and UI help, so anyone following the example for AGS2IFC got a recipe name that does not match the one they selected. Also state that the input file is not read and that a new IFC4X3 model is built, since that is not obvious from the signature and the recipe creates its own project rather than patching the one passed in. Generated with the assistance of an AI coding tool. (cherry picked from commit 9621388953e604a2e3521198a142eef36bfb6de3) --- src/ifcpatch/ifcpatch/recipes/AGS2IFC.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/ifcpatch/ifcpatch/recipes/AGS2IFC.py b/src/ifcpatch/ifcpatch/recipes/AGS2IFC.py index d24aec34e4..9b047a1758 100644 --- a/src/ifcpatch/ifcpatch/recipes/AGS2IFC.py +++ b/src/ifcpatch/ifcpatch/recipes/AGS2IFC.py @@ -47,6 +47,10 @@ class Patcher: This is for AGS version 3. + The input file is not read. A new IFC4X3 model is built from the AGS + data, containing one IfcBorehole per location with its strata nested + inside as IfcGeotechnicalStratum. + :param ags_file: The AGS file to convert. :filter_glob ags_file: *.ags :param docs_dir: The directory URI where documents are stored @@ -55,8 +59,8 @@ class Patcher: .. code:: python - result = ifcpatch.execute({"input": fn, "file": model, "recipe": "ExtractPropertiesToSQLite"}) - ifcpatch.write(result, "output.sqlite") + result = ifcpatch.execute({"file": model, "recipe": "AGS2IFC", "arguments": ["data.ags", "docs"]}) + ifcpatch.write(result, "boreholes.ifc") """ self.file = file self.logger = logger