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

fix: normalize renderIcon types #18683

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

adamalston
Copy link
Contributor

Closes #16735

Normalized renderIcon types.

Changelog

Changed

  • Normalized renderIcon types.

Testing / Reviewing

Paste the code from the issue at the bottom of Tabs.tsx and check for errors.

Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for v11-carbon-web-components ready!

Name Link
🔨 Latest commit 1fe9d8d
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-web-components/deploys/67bdd1e628974f0008204b6e
😎 Deploy Preview https://deploy-preview-18683--v11-carbon-web-components.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for carbon-elements ready!

Name Link
🔨 Latest commit 1fe9d8d
🔍 Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/67bdd1e6785f1200083f2c16
😎 Deploy Preview https://deploy-preview-18683--carbon-elements.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for v11-carbon-react ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 1fe9d8d
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-react/deploys/67bdd1e6aa39a50008f7cae5
😎 Deploy Preview https://deploy-preview-18683--v11-carbon-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.34%. Comparing base (faf6498) to head (1fe9d8d).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #18683   +/-   ##
=======================================
  Coverage   84.34%   84.34%           
=======================================
  Files         409      409           
  Lines       14651    14651           
  Branches     4824     4774   -50     
=======================================
  Hits        12358    12358           
- Misses       2131     2132    +1     
+ Partials      162      161    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@adamalston adamalston marked this pull request as ready for review February 24, 2025 22:44
@adamalston adamalston requested review from a team as code owners February 24, 2025 22:44
@adamalston
Copy link
Contributor Author

adamalston commented Feb 24, 2025

I think all JSDoc comments for renderIcon props should be standardized to use the same text. The props themselves will be consistent with the changes in this pull request, so I think the JSDoc comments for them should be consistent. Curious to hear whether others agree or have any other thoughts.

@Gururajj77
Copy link
Contributor

Hey

I think all JSDoc comments for renderIcon props should be standardized to use the same text. The props themselves will be consistent with the changes in this pull request, so I think the JSDoc comments for them should be consistent. Curious to hear whether others agree or have any other thoughts.

Hey @adamalston , I agree with your suggestion. Can you make change to the comments, and we can see what we can do with that.

@adamalston
Copy link
Contributor Author

I have updated all JSDoc comments. There are a few different ways I envision things could go now:

  • You all think the updates are better. In this case, I will keep all changes.
  • You all think the updates make things worse. In this case, I will revert all changes (i.e., 1fe9d8d).
  • You all think some of the updates make things better and others make things worse. In this case, I will revert everything you think is worse.

Obviously, I'll do whatever you guys want. My goal here was to try and introduce some consistency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Tab renderIcon typescript error when passing Carbon Icon
2 participants