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

Documenting learning equations #1937

Merged
merged 2 commits into from
Dec 30, 2024
Merged

Conversation

lecfab
Copy link
Contributor

@lecfab lecfab commented Dec 23, 2024

Purpose of this PR

Add to in-code documentation a summary of the file calculate_learning_cost.pdf written by @cchrisgong and I when trying to understand learning equations and floor costs.

Remaining issue: the file equations.gms does not seem to be part of automatic documentation generator.

Type of change

  • Refactoring

Checklist:

  • My code follows the coding etiquette
  • I performed a self-review of my own code
  • I checked that the in-code documentation is up-to-date
  • All automated model tests pass (FAIL 0 in the output of make test)

@lecfab lecfab added the documentation Improvements or additions to documentation label Dec 23, 2024
@lecfab lecfab requested a review from cchrisgong December 23, 2024 19:15
@lecfab lecfab merged commit 50e5364 into remindmodel:develop Dec 30, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants