TulipaEnergy/NearOptimalAlternatives.jl

Make the names more understandable

Aperta

#22 aperta il 4 giu 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Julia (4 fork)auto 404
enhancementgood first issue

Metriche repository

Star
 (2 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Rivedi i file collegati e applica le modifiche ai nomi e i miglioramenti ai commenti suggeriti nella issue.
Tech stack
julia
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
95