POSYDON-code/POSYDON

Shorten too long names

オープン

#466 opened on 2024/12/06

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Python (35 件のフォーク)auto 404
enhancementgood first issue

Repository metrics

Stars
 (42 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド