TulipaEnergy/NearOptimalAlternatives.jl

Make the names more understandable

Open

#22 opened on Jun 4, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (4 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

Here are some (minor) suggestions that will improve the readability of the code while going through the repo.

https://github.com/TulipaEnergy/NearOptimalAlternatives.jl/blob/main/src/alternative-optimisation.jl:

  • l 23-25: maybe call them initial_objective* (or original*)
  • l 34: solution -> initial_solution
  • l 40: quite confusing to call a constraint original_objective, so original_objective -> optimality_gap_constraint
  • l 68: better to explain a bit more, e.g., by adding something like so the sum of the distance between the new solution and each of the previous solutions is maximized to the comment
  • l 69: solution -> previous_solution

https://github.com/TulipaEnergy/NearOptimalAlternatives.jl/blob/main/src/results.jl:

  • l 31: shouldn't it be push!(results.objective_values, objective_value(model))? What do we want to store here?

https://github.com/TulipaEnergy/NearOptimalAlternatives.jl/blob/2-mga-metaheuristics/src/generate-alternatives.jl:

  • l108: more explicit name?

Contributor guide

Research direction
Review the linked files and apply the suggested renames and comment improvements as described in the issue.
Tech stack
julia
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95