fix invalid example (create is required)

[stephane-archer]

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and guidance for users migrating from Provider to Riverpod.
  • Expanded sections on ChangeNotifierProvider and ProxyProvider migration.
  • Introduced concepts of eager initialization and code generation.
  • Emphasized a gradual migration approach to improve user experience.
  • Added new method and updated method signature for better usability.

[coderabbitai]

Walkthrough

The pull request focuses on updating the Riverpod migration documentation, specifically the quickstart guide for transitioning from the Provider package. The changes provide a more structured, incremental approach to migration, with enhanced explanations about moving from ChangeNotifierProvider to Riverpod's provider system. The documentation now emphasizes a gradual migration strategy, introduces code generation utilities, and offers clearer guidance on handling different provider types during the transition process.

Changes

File	Change Summary
website/docs/from_provider/quickstart.mdx	- Added method listenAndDisposeChangeNotifier for code generation extension - Updated migration guidance with more detailed, incremental migration steps - Enhanced explanations for ChangeNotifierProvider and ProxyProvider transitions - Introduced section on eager initialization and code generation

Possibly related PRs

• Update random number example from StateNotifier to NotifierProvider #3790: Relates to the transition from StateNotifier to NotifierProvider, supporting the broader migration documentation efforts

Poem

🐰 Migrating code, hop by hop,
From Provider's realm to Riverpod's top
One step at a time, no need to race
Gentle transitions with coding grace
A rabbit's guide to smooth upgrade! 🚀

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

website/docs/from_provider/quickstart.mdx (2)

36-38: Make the create parameter name explicit for better clarity

While the code is functionally correct, making the parameter name explicit would improve readability and align better with the documentation style:

-final myNotifierProvider = ChangeNotifierProvider<MyNotifier>(create: (ref) {
+final myNotifierProvider = ChangeNotifierProvider<MyNotifier>(
+  create: (ref) {
   return MyNotifier();
 });

---

Line range hint 223-227: Consider adding a comment explaining the ignore directive

While the code is correct, it would be helpful to add a comment explaining why the unsupported_provider_value ignore directive is necessary here, as it's part of the temporary migration pattern.

// ignore_for_file: unsupported_provider_value
+// This ignore directive is needed during migration as we're temporarily using
+// ChangeNotifier with code generation until full migration to Notifier
@riverpod
MyNotifier example(Ref ref) {
  return ref.listenAndDisposeChangeNotifier(MyNotifier());
}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 288c9b5 and 4911409.

📒 Files selected for processing (1)

• website/docs/from_provider/quickstart.mdx (1 hunks)

🔇 Additional comments (2)

website/docs/from_provider/quickstart.mdx (2)

Line range hint 214-221: LGTM! Well-implemented utility extension

The extension method correctly handles both listener management and disposal, following best practices for ChangeNotifier lifecycle management.

---

Line range hint 234-239: LGTM! Clear example of the migration target

The example effectively demonstrates the final form of a fully migrated provider using code generation, which serves as a good reference for the end goal of the migration process.

[stephane-archer]

invalid fix