Skip to content

Fix UInt unary negation ScalaDoc (backport #4829) #4831

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: 6.x
Choose a base branch
from

Conversation

chiselbot
Copy link
Collaborator

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.

This is an automatic backport of pull request #4829 done by [Mergify](https://mergify.com).

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

Cherry-pick of 477900b has failed:

On branch mergify/bp/6.x/pr-4829
Your branch is up to date with 'origin/6.x'.

You are currently cherry-picking commit 477900b9.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   core/src/main/scala-2/chisel3/BitsIntf.scala
	deleted by us:   core/src/main/scala-3/chisel3/BitsIntf.scala

no changes added to commit (use "git add" and/or "git commit -a")

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added Backport Automated backport, please consider for minor release bp-conflict labels Mar 25, 2025
@mergify mergify bot mentioned this pull request Mar 25, 2025
14 tasks
@github-actions github-actions bot added the Deprecation Deprecates an API, will be included in release notes label Mar 25, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Backport Automated backport, please consider for minor release bp-conflict Deprecation Deprecates an API, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants