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

Make Property an Element. #3676

Merged
merged 1 commit into from Dec 5, 2023
Merged

Make Property an Element. #3676

merged 1 commit into from Dec 5, 2023

Conversation

mikeurbach
Copy link
Contributor

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

  • Internal or build-related (includes code refactoring/cleanup)

Desired Merge Strategy

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

Release Notes

This is the right place in the Chisel type hierarchy for Property as it exists today. Property types can be used in Aggregates, and are not themselves Aggregates in their current form. Making Property extend Element allows much of Chisel's internal reflection to work as expected when Property types are used in Aggregates.

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, 3.6.x, or 5.x depending on impact, API modification or big change: 6.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.

@mikeurbach mikeurbach added the Internal Internal change, does not affect users, will be included in release notes label Dec 5, 2023
@mikeurbach mikeurbach added this to the 6.0 milestone Dec 5, 2023
Copy link

linux-foundation-easycla bot commented Dec 5, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: mikeurbach / name: Mike Urbach (f90d011)

@mikeurbach
Copy link
Contributor Author

I wasn't sure if this should be marked "internal" or something else...

Also, I wasn't sure how this should be documented. The docs for Data Types and Bundles and Vecs don't really mention Element. I can add something to the Property docs if that makes sense.

@jackkoenig
Copy link
Contributor

I wasn't sure if this should be marked "internal" or something else...

Technically it's an API change, I'm not sure if we want to report it as such though since Property has not been released in an official version, we could just mark it "no release notes"

@mikeurbach
Copy link
Contributor Author

Not marking it an API change since we haven't release Properties makes sense. I sort of like being able to at least mention it in the release notes, so is "Internal" reasonable for that? I can also use "No Release Notes" if that's better.

@jackkoenig
Copy link
Contributor

Internal is good for that 👍

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!

This is the right place in the Chisel type hierarchy for Property as
it exists today. Property types can be used in Aggregates, and are not
themselves Aggregates in their current form. Making Property extend
Element allows much of Chisel's internal reflection to work as
expected when Property types are used in Aggregates.
@jackkoenig jackkoenig merged commit 894172e into main Dec 5, 2023
15 checks passed
@jackkoenig jackkoenig deleted the mikeurbach/property-element branch December 5, 2023 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Internal Internal change, does not affect users, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants