From b60087a16c6116ad7d5235b9a4170c69e15abd28 Mon Sep 17 00:00:00 2001 From: adamburkegh Date: Sat, 4 Jan 2025 22:25:33 +1000 Subject: [PATCH] API comment copyedit --- pmkoalas/models/petrinet.py | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/pmkoalas/models/petrinet.py b/pmkoalas/models/petrinet.py index edddd12..1f922ed 100644 --- a/pmkoalas/models/petrinet.py +++ b/pmkoalas/models/petrinet.py @@ -210,12 +210,9 @@ def __repr__(self) -> str: class LabelledPetriNet: """ - This is a data structure for a class of Petri Nets. - This class consists of places, transitions and directed arcs - between them. - The class contract implies that places and transitions have - labels/names and identifiers. Each instance of this class, - has a name or title for the net. + A labelled Petri Net. It consists of places, transitions and directed arcs + between them. Places and transitions have labels (names) and identifiers. + The net is also named. """ def __init__(self, places:Iterable[Place], transitions:Iterable[Transition], @@ -313,10 +310,9 @@ def __str__(self) -> str: class BuildablePetriNet(LabelledPetriNet): """ - This class allows for the builder design pattern to be used - for constructing a petri net. It allows for users to quickly - add places, transitions and arcs through a single chain of - method calls. See usage below. + Allows for the builder design pattern to be used for constructing a + Petri net. Users can add places, transitions and arcs through a single + chain of method calls. See usage below. Usage -----