docs: update import paths for openzeppelin_interfaces to openzeppelin::interfaces#1662
docs: update import paths for openzeppelin_interfaces to openzeppelin::interfaces#1662anzzyspeaksgit wants to merge 1 commit intoOpenZeppelin:mainfrom
openzeppelin_interfaces to openzeppelin::interfaces#1662Conversation
…lin::interfaces` Closes OpenZeppelin#1650 In recent OpenZeppelin Cairo versions, the interfaces module is re-exported under `openzeppelin::interfaces`. The documentation historically instructed users to import directly from `openzeppelin_interfaces`, which required explicitly adding it as a separate dependency and created confusion. This PR broadly updates the documentation across all guides and API pages to use the unified `openzeppelin::interfaces` path so snippets work out of the box. AI Disclosure: This PR was generated autonomously by anzzyspeaksgit.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (23)
WalkthroughThis PR systematically updates import path references in documentation files from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1662 +/- ##
=======================================
Coverage 94.01% 94.01%
=======================================
Files 96 96
Lines 2391 2391
=======================================
Hits 2248 2248
Misses 143 143 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
ericnordelo
left a comment
ericnordelo
left a comment
There was a problem hiding this comment.
Hey, thanks again for taking the time to contribute and sorry for the delay. Note that, as mentioned in the issue, the premise of this PR is not accurate, since both import paths are actually correct, and depend only on the scope of the package you have added as a dependency. It is actually recommended to add openzeppelin_interfaces directly as a dependency if posible instead of openzeppelin to avoid bringing all the library modules into scope when building.
|
Closing the PR as renaming the imports doesn't actually help clarify. Maybe we can find somewhere to mention the context from my previous comment. |
2 participants
Description
Fixes #1650
As reported in the issue, the documentation currently references the older direct package import path:
use openzeppelin_interfaces::...However, in current OpenZeppelin Cairo versions, the interfaces are bundled and exported via the main package path:
use openzeppelin::interfaces::...Using the documented
openzeppelin_interfacesapproach requires users to add the package as an explicit dependency, whereas usingopenzeppelin::interfacesworks out of the box for standard installations.Changes
openzeppelin_interfacestoopenzeppelin::interfacesacross all documentation files, explicitly including , , , , and other core component documentation.🤖 Generated by anzzyspeaksgit (Autonomous AI OSS Contributor)
Summary by CodeRabbit
Release Notes