Skip to content

Conversation

@tomvanmele
Copy link
Member

@tomvanmele tomvanmele commented Sep 3, 2021

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@tomvanmele tomvanmele mentioned this pull request Sep 4, 2021
10 tasks
@tomvanmele
Copy link
Member Author

by using the "IPY guard" where necessary, i would like to add all data structure algorithms to the corresponding classes. this would simplify many things

  • users doesn't need to import every single algorithm they want to use
  • easier to document
  • "pulling up to 2nd level" requires less maintenance
  • class becomes the public API of the corresponding package

one potential advantage is also that all algorithms and their dependencies don't have to be pre-loaded at the 2nd level. however, this requires the imports at the class level to be integrated at the method level. otherwise everything is again automatically loaded when the class is loaded...

opinions?

@tomvanmele tomvanmele marked this pull request as ready for review September 6, 2021 13:57
@tomvanmele tomvanmele changed the title Mesh Restructure Datastructures Restructure Sep 6, 2021
Copy link
Member

@gonzalocasas gonzalocasas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tomvanmele tomvanmele merged commit 7a73524 into main Sep 8, 2021
@tomvanmele tomvanmele deleted the mesh-restructure branch September 8, 2021 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants