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

Improve the error message for mismatched types in Mux #4331

Merged
merged 1 commit into from
Aug 6, 2024

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Aug 6, 2024

I'm not sure what the best category for this is, not really a feature nor a bug fix, so maybe Documentation?

Before:

can't create Mux with non-equivalent types MuxBetween.in0: IO[MyBundle$1] and MuxBetween.in1: IO[MyBundle$1]

After:

can't create Mux with non-equivalent types _.foo: Left (MuxBetween.in1.foo: IO[UInt<16>]) and Right (MuxBetween.in0.foo: IO[UInt<8>]) have different widths.

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

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

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

@jackkoenig jackkoenig added the Documentation Only changing documentation label Aug 6, 2024
@jackkoenig jackkoenig added this to the 6.x milestone Aug 6, 2024
@jackkoenig jackkoenig requested a review from mwachs5 August 6, 2024 18:46
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.

Nice improvement.

@jackkoenig jackkoenig merged commit a633e78 into main Aug 6, 2024
18 checks passed
@jackkoenig jackkoenig deleted the jackkoenig/better-mux-error-msg branch August 6, 2024 23:14
@mergify mergify bot added the Backported This PR has been backported label Aug 6, 2024
mergify bot pushed a commit that referenced this pull request Aug 6, 2024
chiselbot pushed a commit that referenced this pull request Aug 6, 2024
(cherry picked from commit a633e78)

Co-authored-by: Jack Koenig <koenig@sifive.com>
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 Documentation Only changing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants