Skip to content

Fix UInt unary negation ScalaDoc #4829

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

Merged
merged 1 commit into from
Mar 25, 2025
Merged

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Mar 25, 2025

Fixing a ScalaDoc inconsistency noted on Element.

Note that unary operators are only allowed to be single characters, -, !, ~ and +, so unary_-% has always been invalid to call as a unary operator, you have to call it as myUInt.unary_-% which is just pointless and silly.

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

  • API deprecation

Desired Merge Strategy

  • Squash

Release Notes

Deprecate invalid unary operator unary_-%.

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) and clean up the commit message.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Deprecate invalid unary operator unary_-%.
@jackkoenig jackkoenig added the Deprecation Deprecates an API, will be included in release notes label Mar 25, 2025
@jackkoenig jackkoenig added this to the 6.x milestone Mar 25, 2025
@jackkoenig jackkoenig requested a review from seldridge March 25, 2025 16:30
@jackkoenig jackkoenig merged commit 477900b into main Mar 25, 2025
18 checks passed
@jackkoenig jackkoenig deleted the jackkoenig/unary_negation branch March 25, 2025 21:05
@mergify mergify bot added the Backported This PR has been backported label Mar 25, 2025
chiselbot pushed a commit that referenced this pull request Mar 25, 2025
Deprecate invalid unary operator unary_-%.

(cherry picked from commit 477900b)

# Conflicts:
#	core/src/main/scala-2/chisel3/BitsIntf.scala
#	core/src/main/scala-3/chisel3/BitsIntf.scala
Copy link
Contributor

mergify bot commented Mar 25, 2025

backport

✅ Backports have been created

kammoh pushed a commit to kammoh/chisel that referenced this pull request Mar 26, 2025
Deprecate invalid unary operator unary_-%.
tymcauley added a commit to tymcauley/fixedpoint that referenced this pull request Apr 2, 2025
`UnknownWidth` became a `case object` in this Chisel PR:
chipsalliance/chisel#4242

The `connectFromBits` method was removed in this Chisel PR:
chipsalliance/chisel#4168

The `connectFromBits` API was replaced with the `_fromUInt` API in this
Chisel PR: chipsalliance/chisel#4782

The `NumObject` trait was replaced by the `Num` object in this PR:
chipsalliance/chisel#4768

Wrapping unary negation (`unary_-%`) was deprecated in this PR:
chipsalliance/chisel#4829

The sbt update is necessary to maintain compatibility with the latest
Scala compiler version.
tymcauley added a commit to tymcauley/fixedpoint that referenced this pull request Apr 2, 2025
`UnknownWidth` became a `case object` in this Chisel PR:
chipsalliance/chisel#4242

The `connectFromBits` method was removed in this Chisel PR:
chipsalliance/chisel#4168

The `connectFromBits` API was replaced with the `_fromUInt` API in this
Chisel PR: chipsalliance/chisel#4782

Wrapping unary negation (`unary_-%`) was deprecated in this PR:
chipsalliance/chisel#4829

The sbt update is necessary to maintain compatibility with the latest
Scala compiler version.
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 Deprecation Deprecates an API, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant