POSYDON-code/POSYDON

Shorten too long names

Open

#466 opened on Dec 6, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (35 forks)auto 404
enhancementgood first issue

Repository metrics

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

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.

Contributor guide

Research direction
Identify functions and parameters with overly long names in the codebase, especially those exceeding 70 characters, and propose shorter alternatives following the guidelines (acronyms, shorter words, removing redundant prepositions).
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70