CCSDSPy / ccsdspy

I/O interface and utilities for CCSDS binary spacecraft data in Python. Library used in flight missions at NASA, NOAA, and SWRI
https://ccsdspy.org
BSD 3-Clause "New" or "Revised" License
74 stars 18 forks source link

Rename method names `from_file`, `load`, `to_file` #67

Open ehsteve opened 1 year ago

ehsteve commented 1 year ago

Currently, the method names are

I feel like all of these function names are unclear and require someone to read the documentation to figure out what they do which should not be the case.

The purpose of this issue is to discuss whether it is worthwhile to change these names and what the new names might be.

ehsteve commented 1 year ago

One suggestion for new names

ddasilva commented 1 year ago

We'll see what others think.. i think load() is as clear as parse() but I might be biased because I've stared at it so long. Changing from_file() to define_from_file() is definitely reasonable.

I do want to weigh these breaking API changes in terms of benefit to users vs annoyance to users. At the very least such changes should occur at major version changes. In general I think we should avoid breaking the API so much that we get ourselves a reputation where "upgrading ccsdspy means a lot of work."

ehsteve commented 1 year ago

Totally agree with you. May not be worth making some changes like for load. The reason I don't like load is that it could mean loading any file to do just about anything.