POSYDON-code/POSYDON

Shorten too long names

Offen

#466 geöffnet am 06.12.2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (35 Forks)auto 404
enhancementgood first issue

Repository-Metriken

Stars
 (42 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Identifizieren Sie übermäßig lange Funktions und Parameternamen im Code, insbesondere solche, die 70 Zeichen überschreiten, und schlagen Sie kürzere Alternativen vor, die den Richtlinien folgen (Akronyme, kürzere Wörter, Entfernung überflüssiger Präpositionen).
Tech Stack
python
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70