This issue is intended to discuss some names in this repo and potentially come up with better names for future releases. It should be extended, whenever one encounters another sub-optimal name.
[ ] docname vs dataset_name --> Better use document_name and dataset_name
[ ] clsname --> class_name
[ ] CropObject --> ???. Can a CropObject contain something else than a music symbol primitive? We really have to follow a certain naming convention. If we can't change the name, let's at least call it crop_object when being used.
[ ] Method imfile ... what is that!? How about build_image_path
[ ] Documentation says for top/left/... something cryptic like 'horizontal dimension (column) of the upper left corner pixel' ... what? How about 'x-position of left upper corner in pixel'? And if it truly is a pixel, how can it be a float value?
[ ] export_cropobject_class_list --> Very irritating. Does it expect CropObject or CropObjectClass? Documentation is inconsistent. Changed to CropObjectClass, please check.
[ ] clsid --> If really required, at least call it class_id, if that is what it's supposed to mean.
[ ] if bottom/top, ... is float, this creates problems in cropobject.join
apacha
commented
5 years ago
This issue is intended to discuss some names in this repo and potentially come up with better names for future releases. It should be extended, whenever one encounters another sub-optimal name.
docnamevsdataset_name--> Better usedocument_nameanddataset_nameclsname-->class_nameCropObject--> ???. Can a CropObject contain something else than a music symbol primitive? We really have to follow a certain naming convention. If we can't change the name, let's at least call it crop_object when being used.imfile... what is that!? How aboutbuild_image_pathexport_cropobject_class_list--> Very irritating. Does it expect CropObject or CropObjectClass? Documentation is inconsistent. Changed to CropObjectClass, please check.clsid--> If really required, at least call it class_id, if that is what it's supposed to mean.cropobject.join