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.
This commit is contained in:
Petru Conduraru
2026-07-25 11:50:54 +03:00
committed by Dion Moult
parent 89523999b3
commit 9621388953
+6 -2
View File
@@ -47,6 +47,10 @@ class Patcher:
This is for AGS version 3. 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. :param ags_file: The AGS file to convert.
:filter_glob ags_file: *.ags :filter_glob ags_file: *.ags
:param docs_dir: The directory URI where documents are stored :param docs_dir: The directory URI where documents are stored
@@ -55,8 +59,8 @@ class Patcher:
.. code:: python .. code:: python
result = ifcpatch.execute({"input": fn, "file": model, "recipe": "ExtractPropertiesToSQLite"}) result = ifcpatch.execute({"file": model, "recipe": "AGS2IFC", "arguments": ["data.ags", "docs"]})
ifcpatch.write(result, "output.sqlite") ifcpatch.write(result, "boreholes.ifc")
""" """
self.file = file self.file = file
self.logger = logger self.logger = logger