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.

Sign up for GitHub

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

Jump to bottom

Add suggestName method to HasTarget #3881

Merged
merged 4 commits into from
Feb 28, 2024
Merged

Add suggestName method to HasTarget #3881

merged 4 commits into from
Feb 28, 2024

Conversation

debs-sifive
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

  • Feature (or new API)

Desired Merge Strategy

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

Release Notes

HasTarget trait now also exposes suggestName method of a NamedComponent.

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.

@debs-sifive debs-sifive added the Feature New feature, will be included in release notes label Feb 27, 2024
jackkoenig
jackkoenig reviewed Feb 27, 2024
View reviewed changes
core/src/main/scala/chisel3/package.scala Outdated
Comment on lines 423 to 424

def suggestName(name: String): Unit
Copy link
Contributor

Choose a reason for hiding this comment

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

Why does this get a blank line but nothing above it does? A ScalaDoc would be good though 🙂

jackkoenig
jackkoenig approved these changes Feb 27, 2024
View reviewed changes
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, nice test. ScalaDoc would be good

@jackkoenig jackkoenig added this to the 6.x milestone Feb 27, 2024
@debs-sifive debs-sifive enabled auto-merge (squash) February 28, 2024 00:17
@debs-sifive debs-sifive merged commit c161fcc into main Feb 28, 2024
14 checks passed
@debs-sifive debs-sifive deleted the debs/hastarget-suggestname branch February 28, 2024 00:20
@mergify mergify bot added the Backported This PR has been backported label Feb 28, 2024
mergify bot pushed a commit that referenced this pull request Feb 28, 2024
@debs-sifive @mergify
Add suggestName method to HasTarget (#3881)
f345d0a 
(cherry picked from commit c161fcc)
@mergify mergify bot mentioned this pull request Feb 28, 2024
Merged
14 tasks
chiselbot pushed a commit that referenced this pull request Feb 28, 2024
@mergify @debs-sifive @jackkoenig
Add suggestName method to HasTarget (backport #3881) (#3882)
fbb5f65 
* Add `suggestName` method to `HasTarget` (#3881)

(cherry picked from commit c161fcc)

* Waive binary compatibility issues

---------

Co-authored-by: Deborah Soung <debs@sifive.com>
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
Reviewers

@jackkoenig jackkoenig jackkoenig approved these changes

Assignees
No one assigned
Labels
Backported This PR has been backported Feature New feature, will be included in release notes
Projects
None yet
Milestone
6.x
Development

Successfully merging this pull request may close these issues.
2 participants
@debs-sifive @jackkoenig