Formalise the "private helper methods" need in the Adapters

BHoM / BHoM_Adapter

GNU Lesser General Public License v3.0

7 stars 5 forks source link

Formalise the "private helper methods" need in the Adapters #201

Open alelom opened 4 years ago

alelom commented 4 years ago

Description:

Take GSA_Adapter. The main file includes many methods that are just there because of two reasons:

They must not be exposed to the UI
They don't fit any other Folder category (Push/Pull methods, Convert methods, Create/Modify/Query/...)

This happens often. Instead of flooding the main Adapter file with these definitions, we should have a more appropriate location for these.

One idea could be a folder "Private methods", if we like it. Open to suggestions.

@IsakNaslundBh

FraserGreenroyd commented 4 years ago

I'm not a fan of 'private methods' as a folder name but do agree we should segregate the methods out. Maybe 'helper' methods? Though 'helper' isn't quite the right word either...

alelom commented 4 years ago

I'm not a fan of 'private methods' as a folder name but do agree we should segregate the methods out. Maybe 'helper' methods? Though 'helper' isn't quite the right word either...

That's the point. I don't like neither "private" nor "helper" methods. But in reality, this is the situation we're in. We're having the main BHoM_Adapter file that becomes the aggregation point of all a series of "attached" methods that can't be categorised under our model for the only two reasons stated above. Since is a repeated and diffused case I think BHoM should take them into account. @al-fisher