POSYDON-code/POSYDON

Shorten too long names

开放

#466 创建于 2024年12月6日

 (0 条评论) (0 个反应) (0 位负责人)Python (35 个派生)auto 404
enhancementgood first issue

仓库指标

星标
 (42 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南