Skip to content
This repository has been archived by the owner on Oct 23, 2022. It is now read-only.

Need AbstractLatticeCluster type so can write generic code for lattice clusters #302

Merged
merged 1 commit into from
Oct 19, 2021

Conversation

BrianGun
Copy link
Contributor

@BrianGun BrianGun commented Oct 19, 2021

Fixes #301

Added AbstractLatticeCluster type and more documentation explaining the interface associated with the type.

Pull Request Template

Description

Want to write generic functions that accept any type of lattic cluster object but currently there isn't an abstract type that all lattice cluster concrete types inherit from. Added this type and updated documentation to describe the interface of AbstractLatticeCluster.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [x ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

added test to verify that declaring function arguments to be of type AbstractLatticeCluster works.

Checklist:

  • [x ] My code follows the style guidelines of this project
  • [ x] I have performed a self-review of my own code
  • [ x] I have commented my code, particularly in hard-to-understand areas
  • [ x] I have made corresponding changes to the documentation
  • [ x] My changes generate no new warnings
  • [ x] I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • [ x] I have checked my code and corrected any misspellings

…e clusters

Fixes #301

Added AbstractLatticeCluster type and more documentation explaining the interface associated with the type.
@BrianGun BrianGun merged commit 904e4c9 into main Oct 19, 2021
@BrianGun BrianGun deleted the BrianGun/issue301 branch October 19, 2021 21:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need AbstractLatticeCluster type so can write generic code for lattice clusters
2 participants