Improve internal method naming / organization

stuart-cls / python-agilent-file-formats

Python library for reading FT-IR imaging datasets created by Resolutions Pro on Agilent Cary instruments with FPA area detectors.

MIT License

3 stars 0 forks source link

Improve internal method naming / organization #1

Closed stuart-cls closed 4 months ago

stuart-cls commented 5 years ago

From orange-spectroscopy #262, Marko suggested:

For def _get_prop_str(dat, param):

I would have named this internal helpers differently: I would not use the underscore. Also, "get" can often seems a bit superfluous.

and for def _get_data(self):

For, the name _get_data was a bit confusing and was looking for what it actually returns. Perhaps a name such as _prepare_data or _load_data or similar would be more appropriate next time.