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

Added .exclude to Connectable #3172

Merged
merged 1 commit into from
Apr 12, 2023
Merged

Added .exclude to Connectable #3172

merged 1 commit into from
Apr 12, 2023

Conversation

azidar
Copy link
Contributor

@azidar azidar commented Apr 11, 2023

Added a .exclude mechanism to Connectable, allowing fields to always be ignored by any connectable operator.

This is useful for omitting all Analog types from a bundle, prior to connecting it. I believe we should then make the directioned operators (:=, :#=, :<>= etc.) just error if it encounters an Analog type, but that can be a future PR.

This also jives with #3088 as probe types should also be omitted, as they have their own "connection-like" API called define.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Feature (or new API)

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference.

Release Notes

Added .exclude mechanism on Connectable to enable never connecting to/from the marked fields using any connectable operator.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.5.x or 3.6.x depending on impact, API modification or big change: 5.0.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@azidar azidar added the Feature New feature, will be included in release notes label Apr 11, 2023
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

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

the docs make sense to me!

@jackkoenig jackkoenig added this to the 3.6.x milestone Apr 12, 2023
Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

LGTM but 1 request and 1 question.

@azidar azidar force-pushed the connectable-exclude branch from cadf385 to 801d0f5 Compare April 12, 2023 23:06
@jackkoenig jackkoenig merged commit 4b891ec into main Apr 12, 2023
@jackkoenig jackkoenig deleted the connectable-exclude branch April 12, 2023 23:56
@mergify mergify bot added the Backported This PR has been backported label Apr 12, 2023
mergify bot pushed a commit that referenced this pull request Apr 12, 2023
mergify bot added a commit that referenced this pull request Apr 13, 2023
(cherry picked from commit 4b891ec)

Co-authored-by: Adam Izraelevitz <[email protected]>
@sequencer sequencer mentioned this pull request Jun 20, 2023
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Feature New feature, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants