From 04b06712ec16ed67e7417b957dca6f07a7a0ddb0 Mon Sep 17 00:00:00 2001 From: Niclas Garan Date: Wed, 22 Nov 2023 02:02:31 +0100 Subject: [PATCH] add docstrings to public cdef attributes --- interfaces/cython/cantera/reactor.pxd | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/interfaces/cython/cantera/reactor.pxd b/interfaces/cython/cantera/reactor.pxd index 71a17a035..29499e5f9 100644 --- a/interfaces/cython/cantera/reactor.pxd +++ b/interfaces/cython/cantera/reactor.pxd @@ -225,11 +225,19 @@ cdef class ReactorBase: cdef list _surfaces cdef object _weakref_proxy cdef public dict node_attr + """ + A dictionary containing draw attributes for the representation of the reactor as a graphviz + node. See https://graphviz.org/docs/nodes/ for a list of all usable attributes. + """ cdef class Reactor(ReactorBase): cdef CxxReactor* reactor cdef object _kinetics cdef public str groupname + """ + Optional name of a grouping of reactors that will be drawn as a cluster in the graphical + representation using graphviz. See https://graphviz.org/Gallery/directed/cluster.html. + """ cdef class MoleReactor(Reactor): pass @@ -261,6 +269,10 @@ cdef class ReactorSurface: cdef Kinetics _kinetics cdef ReactorBase _reactor cdef public dict node_attr + """ + A dictionary containing draw attributes for the representation of the reactor surface as a + graphviz node. See https://graphviz.org/docs/nodes/ for a list of all usable attributes. + """ cdef class WallBase: cdef shared_ptr[CxxWallBase] _wall @@ -271,6 +283,10 @@ cdef class WallBase: cdef ReactorBase _right_reactor cdef str name cdef public dict edge_attr + """ + A dictionary containing draw attributes for the representation of the `WallBase` as a + graphviz edge.See https://graphviz.org/docs/edges/ for a list of all usable attributes. + """ cdef class Wall(WallBase): pass @@ -284,6 +300,10 @@ cdef class FlowDevice: cdef ReactorBase _upstream cdef ReactorBase _downstream cdef public dict edge_attr + """ + A dictionary containing draw attributes for the representation of the `FlowDevice` as a + graphviz edge.See https://graphviz.org/docs/edges/ for a list of all usable attributes. + """ cdef class MassFlowController(FlowDevice): pass