POSYDON-code/POSYDON

Shorten too long names

Ouverte

#466 ouverte le 6 déc. 2024

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Python (35 forks)auto 404
enhancementgood first issue

Métriques du dépôt

Stars
 (42 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Identifiez dans le code les noms de fonctions et de paramètres trop longs, en particulier ceux dépassant 70 caractères, et proposez des alternatives plus courtes en suivant les directives (acronymes, mots plus courts, suppression des prépositions redondantes).
Stack technique
python
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70