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.

貢獻者指南