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

BHoM_Adapter: update&correct Toolkit template #93

Open
3 tasks
alelom opened this issue Jun 6, 2019 · 0 comments
Open
3 tasks

BHoM_Adapter: update&correct Toolkit template #93

alelom opened this issue Jun 6, 2019 · 0 comments
Assignees
Labels
type:compliance Non-conforming to code guidelines type:feature New capability or enhancement

Comments

@alelom
Copy link
Member

alelom commented Jun 6, 2019

Once the refactoring (#84) is done, update the Visual Studio Template for the generation of the Toolkits code.

This should also include a correction of the previous behaviour that moved some files in the wrong folder, as illustrated in the wiki itself.

  • 1) Update to latest refactored adapter structure
  • 2) Correct/expand/improve the comments
  • 3) Update/improve the Engine Method Templates

2) Correct/expand/improve the comments

Tips I would've found useful:

  • Above the adapter constructor, specify that any parameter added will be reflected automatically in the parameters of the GH/Dyn/Excel component.

Corrections I would find useful:

  • Having distinct comment "regions" for Private methods and Private fields is not correct by definition (fields include the methods). Rename Private fields to Private variables.
  • The comment region Public Fields seems to appear twice.
  • I would delete the Public Fields naming and replace it with two: Public Properties and Public Methods (Push, Pull, and any other public method).

Additional notes

Closes https://github.com/BuroHappoldEngineering/BHoM_Documentation/issues/32

@alelom alelom added type:compliance Non-conforming to code guidelines type:feature New capability or enhancement labels Jun 6, 2019
@alelom alelom self-assigned this Jun 6, 2019
@alelom alelom changed the title BHoM_Adapter: refactoring-update&correct Toolkit template BHoM_Adapter: update&correct Toolkit template Jul 3, 2019
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
Projects
None yet
Development

No branches or pull requests

1 participant