Skip to content

Commit 6ce72c3

Browse files
committed
clarify 'carve' docstrings
1 parent 8d24473 commit 6ce72c3

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

pytrsplat/plat_gen/plat.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,10 +253,13 @@ def carve_tract(self, tract: pytrs.Tract, layer: str = None) -> None:
253253
layer. They **can** be added to the queue for a different
254254
layer.
255255
256+
Carve-outs for any given layer can be cleared with
257+
``.clear_layer_carveouts(layer=<name>)``.
258+
256259
.. warning::
257260
258261
**Any** lots or aliquots identified in this tract will be
259-
removed from the queue. Be careful to use a 'clean'
262+
removed from the layer. Be careful to use a 'clean'
260263
description that will not remove lands that should be kept.
261264
262265
:param tract: A ``pytrs.Tract`` that has been parsed into Lots
@@ -300,10 +303,13 @@ def carve_tracts(
300303
layer. They **can** be added to the queue for a different
301304
layer.
302305
306+
Carve-outs for any given layer can be cleared with
307+
``.clear_layer_carveouts(layer=<name>)``.
308+
303309
.. warning::
304310
305311
**Any** lots or aliquots identified in these tracts will be
306-
removed from the queue. Be careful to use 'clean'
312+
removed from the layer. Be careful to use 'clean'
307313
descriptions that will not remove lands that should be kept.
308314
309315
:param tracts: A collection of ``pytrs.Tract`` objects,
@@ -341,10 +347,13 @@ def carve_description(
341347
layer. They **can** be added to the queue for a different
342348
layer.
343349
350+
Carve-outs for any given layer can be cleared with
351+
``.clear_layer_carveouts(layer=<name>)``.
352+
344353
.. warning::
345354
346355
**Any** lots or aliquots identified in this description will
347-
be removed from the queue. Be careful to use a 'clean'
356+
be removed from the layer. Be careful to use a 'clean'
348357
description that will not remove lands that should be kept.
349358
350359
:param txt: The land description.

0 commit comments

Comments
 (0)