Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
alelom opened this issue Feb 19, 2020 · 2 comments
Open

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

alelom opened this issue Feb 19, 2020 · 2 comments
Labels
type:compliance Non-conforming to code guidelines type:feature New capability or enhancement type:question Ask for further details or start conversation

Comments

@alelom
Copy link
Member

alelom commented Feb 19, 2020

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

@alelom alelom added type:compliance Non-conforming to code guidelines type:feature New capability or enhancement type:question Ask for further details or start conversation labels Feb 19, 2020
@FraserGreenroyd
Copy link
Contributor

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
Copy link
Member Author

alelom commented Feb 20, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:compliance Non-conforming to code guidelines type:feature New capability or enhancement type:question Ask for further details or start conversation
Projects
None yet
Development

No branches or pull requests

2 participants