search

TopoToolbox / pytopotoolbox

Python interface to TopoToolbox
GNU General Public License v3.0
1 stars 2 forks source link

Decide on a naming strategy #13

Open wkearn opened 1 month ago

wkearn commented 1 month ago

11 adds a GridObject class, which has a different name from GRIDobj as used in the MATLAB version. There is some discussion in #11 about naming, but nothing was settled, and I can see good arguments for both or even for other options. I want to merge #11 so we can start moving forward with figuring out some of the package's functionality, but I want to make sure that we still decide what the names should be, not just for GRIDobj/GridObject, but for other data structures and functions that we might need going forward.

Teschl commented 1 month ago

Regarding GRIDobj, we can either decide on one name for GRIDobj or add multiple aliases (which could lead to confusion). I far as I was aware, we need to decide between:

What solution would you prefer @wschwanghart ?

wschwanghart commented 1 month ago

I would certainly prefer the awkward but familiar name GRIDobj. 😉