search

Cantera / cantera-website

Official Cantera Website
https://cantera.org
Other
14 stars 26 forks source link

Make Python WallBase Documentation #156

Closed stijn76 closed 2 years ago

stijn76 commented 2 years ago

Hi!

The python documentation on the cantera website is missing any information on the WallBase class. Yet this would be convenient to figure out how to get the values for e.g. the wall area and heat flux (qdot(t)). I had to go to the class files to figure out, now. Not sure if there is an easy way to perhaps automatically generate such documentation?

Many thanks for taking this into consideration!

Best regards,

Stijn

ischoegl commented 2 years ago

Hi @stijn76 ... thanks for reporting this issue. Could you be more specific about where this issue arises? The C++ code itself is documented (see Cantera C++ documentation).

For the Python API, there indeed is no WallBase entry for zero-dimensional reactor networks. As this is a base class, this may be a deliberate choice, as the Python class itself is documented as well.

PS: Transferring this to the website repo, as the source code itself is documented.

bryanwweber commented 2 years ago

As @ischoegl said, there is C++ documentation generated, and documentation is present for the Wall class in Python. I'm going to close this; @stijn76 please feel free to reopen with a comment as to how this can be clarified!