Skip to content

[TOOL-4591] Fix resolveImplementation jsdoc code example in jsdoc #7141

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

Conversation

MananTank
Copy link
Member

@MananTank MananTank commented May 23, 2025


PR-Codex overview

This PR updates the import path for the resolveImplementation function in the resolveImplementation.ts file to reflect its new location within the thirdweb/utils directory.

Detailed summary

  • Changed the import statement for resolveImplementation from:
    • import { resolveImplementation } from "thirdweb";
    • to import { resolveImplementation } from "thirdweb/utils";

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Documentation
    • Updated example import path in documentation for improved clarity.

Copy link

linear bot commented May 23, 2025

Copy link

vercel bot commented May 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2025 5:19pm
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2025 5:19pm
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2025 5:19pm
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2025 5:19pm
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2025 5:19pm

Copy link

changeset-bot bot commented May 23, 2025

⚠️ No Changeset found

Latest commit: 916ecf4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@MananTank MananTank marked this pull request as ready for review May 23, 2025 14:18
@MananTank MananTank requested review from a team as code owners May 23, 2025 14:18
Copy link
Contributor

coderabbitai bot commented May 23, 2025

Walkthrough

The only modification in this change is an update to the JSDoc example import path for the resolveImplementation function, changing it from "thirdweb" to "thirdweb/utils". No code logic, exports, or control flow have been altered.

Changes

File(s) Change Summary
packages/thirdweb/src/utils/bytecode/resolveImplementation.ts Updated JSDoc example import path for resolveImplementation

Assessment against linked issues

Objective Addressed Explanation
Review issue with auto-reference documentation and SDK export path for resolveImplementation ([TOOL-4591])

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • TEAM-0000: Entity not found: Issue - Could not find referenced Issue.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc92e15 and 916ecf4.

📒 Files selected for processing (1)
  • packages/thirdweb/src/utils/bytecode/resolveImplementation.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/thirdweb/src/utils/bytecode/resolveImplementation.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Size
  • GitHub Check: Lint Packages
  • GitHub Check: Analyze (javascript)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added packages SDK Involves changes to the thirdweb SDK labels May 23, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/thirdweb/src/utils/bytecode/resolveImplementation.ts (1)

21-21: Update JSDoc example import path
The import path in the JSDoc example has been corrected to "thirdweb/utils", matching the actual location of resolveImplementation.
Please verify that any other documentation or code samples (e.g., README, tutorials) are updated to use this new path as well.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 317211a and cc92e15.

📒 Files selected for processing (1)
  • packages/thirdweb/src/utils/bytecode/resolveImplementation.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Build Packages
  • GitHub Check: Lint Packages
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Size
  • GitHub Check: Analyze (javascript)

@MananTank MananTank changed the title [TOOL-4591] Fix resolveImplementation jsdoc code example [TOOL-4591] Fix resolveImplementation jsdoc code example in jsdoc May 23, 2025
Copy link
Contributor

github-actions bot commented May 23, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 56.62 KB (0%) 1.2 s (0%) 221 ms (+129.2% 🔺) 1.4 s
thirdweb (cjs) 309.13 KB (0%) 6.2 s (0%) 885 ms (+6.25% 🔺) 7.1 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 58 ms (+705.03% 🔺) 172 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 17 ms (+487.5% 🔺) 27 ms
thirdweb/react (minimal + tree-shaking) 19.5 KB (0%) 390 ms (0%) 92 ms (+503.94% 🔺) 482 ms

Copy link

codecov bot commented May 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.62%. Comparing base (d1ca9af) to head (916ecf4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7141      +/-   ##
==========================================
- Coverage   55.63%   55.62%   -0.01%     
==========================================
  Files         902      902              
  Lines       58190    58190              
  Branches     4098     4098              
==========================================
- Hits        32373    32369       -4     
- Misses      25712    25716       +4     
  Partials      105      105              
Flag Coverage Δ
packages 55.62% <ø> (-0.01%) ⬇️
Files with missing lines Coverage Δ
...irdweb/src/utils/bytecode/resolveImplementation.ts 80.14% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

graphite-app bot commented May 23, 2025

Merge activity

)

<!--

## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

## Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

## How to test

Unit tests, playground, etc.

-->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR updates the import path for the `resolveImplementation` function to reflect its new location within the `thirdweb/utils` directory.

### Detailed summary
- Changed import statement for `resolveImplementation` from `thirdweb` to `thirdweb/utils`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **Documentation**
  - Updated example import path in documentation for improved clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages SDK Involves changes to the thirdweb SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants