POSYDON-code / POSYDON-code/POSYDON

Shorten too long names

Open
#466 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Python
Stars
45
Forks
37
Avg merge
8d 20h
Merged PRs (30d)
5

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by surveying the project’s Python function and parameter names, using the issue’s long-name example as a reference. Done requires an agreed naming scope and explicit list of names to shorten without losing clarity.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.