Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Tracked by #701
clizbe opened this issue Aug 5, 2024 · 2 comments
Open
Tracked by #701

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

clizbe opened this issue Aug 5, 2024 · 2 comments
Labels
good first issue Good for newcomers

Comments

@clizbe
Copy link
Member

clizbe commented Aug 5, 2024

What and Why

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

  • capacity.jl
  • consumer.jl
  • conversion.jl
  • energy.jl
  • hub.jl
  • investment.jl
  • storage.jl
  • transport.jl

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

@clizbe clizbe changed the title Add argument descriptions to all constraints scripts Add argument descriptions to all "add contraints" functions Aug 5, 2024
@clizbe clizbe changed the title Add argument descriptions to all "add contraints" functions Add argument descriptions to all "add constraints" functions Aug 5, 2024
@datejada
Copy link
Member

datejada commented Aug 6, 2024

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 😄

@datejada datejada mentioned this issue Aug 6, 2024
52 tasks
@clizbe clizbe added the good first issue Good for newcomers label Aug 29, 2024
@abelsiqueira
Copy link
Member

The arguments of all these functions should have been simplified to only require properly named arguments (connection, model, etc.). The docstrings will still need to be updated after the bulk of the refactor is done, but the arguments should now be clearer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants