Catalyst.jl icon indicating copy to clipboard operation
Catalyst.jl copied to clipboard

Add documentation for chemistry related functionality

Open TorkelE opened this issue 2 years ago • 4 comments

The compound and reaction balancing functionality has been added in: https://github.com/SciML/Catalyst.jl/pull/651 https://github.com/SciML/Catalyst.jl/pull/657 https://github.com/SciML/Catalyst.jl/pull/667 but are not yet documented, this should be added at some point.

TorkelE avatar Sep 17 '23 18:09 TorkelE

@LalitChauhan56 are you still planning to do this?

isaacsas avatar Sep 17 '23 18:09 isaacsas

Note that a basic tutorial would just introduce what I summarized in the HISTORY.md file.

isaacsas avatar Sep 17 '23 18:09 isaacsas

Also, the macro and balance_reaction should get proper doc strings showing their usage and discussing what they return.

isaacsas avatar Sep 17 '23 18:09 isaacsas

Yes, I have a basic draft ready. I'll put up a PR by EOD.

LalitChauhan56 avatar Sep 18 '23 08:09 LalitChauhan56

now works on master

TorkelE avatar Jun 04 '24 19:06 TorkelE