migra icon indicating copy to clipboard operation
migra copied to clipboard

Refactor request: more informative variable/parameter/function names

Open SKalt opened this issue 4 years ago • 2 comments

Working on #114, I've found myself wishing for more informative variable names. Here's a preliminary list of suggested refactors:

  • changes.py:
    • statements_for_changes
      • things_from, things_target -> source_<type of source>, target_<type of target>
    • statements_from_differences
      • v -> what v is
  • migra.py
    • Migration.__init__
      • x_from, x_target: -> source_<type of source>, target_<type of target>

SKalt avatar Jan 20 '20 17:01 SKalt

Yeah, these admittedly aren't brilliant, but until recently have been for internal consumption only.

Need to think carefully about the before -> after naming in particular. Definitely want to standardize but I've had people complain before that the names I chose for these in various places were confusing to them.

djrobstep avatar Feb 27 '20 02:02 djrobstep

Yeah, these admittedly aren't brilliant, but until recently have been for internal consumption only.

completely understandable.

Need to think carefully about the before -> after naming in particular. Definitely want to standardize but I've had people complain before that the names I chose for these in various places were confusing to them.

No rush. I'm glad you got time to look at this issue!

SKalt avatar Feb 27 '20 12:02 SKalt