POSYDON-code/POSYDON

Shorten too long names

Aperta

#466 aperta il 6 dic 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (35 fork)auto 404
enhancementgood first issue

Metriche repository

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

Descrizione

Some times names get very long when being explicit, this becomes a problem, when both a function name and the name of a parameter are long. It isn't necessary to have the same explicit part on the function and on the variable, here an example:

  • calculate_lambda_from_profile(*, common_envelope_option_for_lambda=*) is already 70 characters and therefore effectively unusable without a line break.

What we could do:

  • use acronyms, e.g. CE instead of common_envelope,
  • use shorter words, e.g. get instead of calculate
  • only use needed prepositions

Surly, don't cut all names down to bare minimum, it's more about getting the longest a bit shorter.

Guida contributor

Direzione di ricerca
Identifica nel codice funzioni e parametri con nomi eccessivamente lunghi, soprattutto quelli superiori a 70 caratteri, e proponi alternative più brevi seguendo le linee guida (acronimi, parole più corte, rimozione di preposizioni ridondanti).
Tech stack
python
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70