Rename method names from_file, load, to_file

[ehsteve]

Currently, the method names are

• load(filename) - to parse a binary file
• from_file(filename) - to create a packet definition from a file (only csv right now)
• to_file(filename) - to create a binary file with synthetic data (coming soon!)

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]

One suggestion for new names

• load() to parse()
• from_file() to define_from_file()
• to_file() no change?

[ddasilva]

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]

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.