search

TulipaEnergy / TulipaEnergyModel.jl

An energy system optimization model that is flexible, computationally efficient, and academically robust.
Apache License 2.0
22 stars 19 forks source link

Add argument descriptions to all "add constraints" functions #723

Open clizbe opened 1 month ago

clizbe commented 1 month ago

What and Why

The functions in the constraints folder should describe the arguments for the functions. These files are:

Here's an example of the lack of argument documentation. What are the Ai, Ase, Fi, etc arguments? image

Possible Drawbacks

No response

Related Issues

No response

datejada commented 1 month ago

Thanks! This action was identified in the refactor EPIC, but It had not issue assigned (until now 😝). I'm adding the issue to the EPIC 😄