From f020046e1fed2c4cdd2c44efa4e496c16c08f364 Mon Sep 17 00:00:00 2001
From: Valentin Vignal <32538273+ValentinVignal@users.noreply.github.com>
Date: Wed, 19 Apr 2023 16:50:29 +0800
Subject: [PATCH] Fix some typos + better error message for non-overridden
 dependencies (#2452)

---
 packages/riverpod/CHANGELOG.md                   |  5 +++++
 .../riverpod/lib/src/framework/container.dart    |  2 +-
 packages/riverpod/lib/src/framework/element.dart | 16 ++++++++--------
 3 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md
index 967a90b44..9a319d7c1 100644
--- a/packages/riverpod/CHANGELOG.md
+++ b/packages/riverpod/CHANGELOG.md
@@ -1,3 +1,8 @@
+## Unreleased fix
+
+- Improved error message for missing `dependencies` (thanks to @ValentinVignal)
+- Fixed various typos in the documentation (thanks to @ValentinVignal)
+
 ## 2.3.5 - 2023-04-18
 
 - fix `AsyncValue.isReloading` docs
diff --git a/packages/riverpod/lib/src/framework/container.dart b/packages/riverpod/lib/src/framework/container.dart
index 4e32dfcf6..bb5055d7d 100644
--- a/packages/riverpod/lib/src/framework/container.dart
+++ b/packages/riverpod/lib/src/framework/container.dart
@@ -459,7 +459,7 @@ class ProviderContainer implements Node {
                 '''
 Tried to read $provider from a place where one of its dependencies were overridden but the provider is not.
 
-To fix this error, you can add "dependencies" to $provider such that we have:
+To fix this error, you can add $dependency (a) to the "dependencies" of $provider (b) such that we have:
 
 ```
 final a = Provider(...);
diff --git a/packages/riverpod/lib/src/framework/element.dart b/packages/riverpod/lib/src/framework/element.dart
index 5a1417ec6..1c722e0bd 100644
--- a/packages/riverpod/lib/src/framework/element.dart
+++ b/packages/riverpod/lib/src/framework/element.dart
@@ -37,9 +37,9 @@ void Function()? debugCanModifyProviders;
 ///
 /// This is what keeps track of the state of a provider, and notifies listeners
 /// when the state changes. It is also responsible for rebuilding the provider
-/// when once of its dependencies changes.
+/// when one of its dependencies changes.
 ///
-/// This class is not meant to be used directly and is an implemnetation detail
+/// This class is not meant to be used directly and is an implementation detail
 /// of providers.
 /// Do not use.
 /// {@endtemplate}
@@ -159,10 +159,10 @@ abstract class ProviderElementBase<State> implements Ref<State>, Node {
     }
   }
 
-  /// Obtains the current state, of null if the provider has yet to initialize.
+  /// Obtains the current state, or null if the provider has yet to initialize.
   ///
   /// The returned object will contain error information, if any.
-  /// This function does not cause the provider to rebuild if it someohow was
+  /// This function does not cause the provider to rebuild if it somehow was
   /// outdated.
   ///
   /// This is not meant for public consumption. Instead, public API should use
@@ -453,7 +453,7 @@ abstract class ProviderElementBase<State> implements Ref<State>, Node {
   void notifyListeners() {
     final currentResult = getState();
     // If `notifyListeners` is used during `build`, the result will be null.
-    // Throwing would be unnecesserily inconvenient, so we simply skip it.
+    // Throwing would be unnecessarily inconvenient, so we simply skip it.
     if (currentResult == null) return;
 
     if (_didBuild) {
@@ -623,7 +623,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu
         if (listenable is! ProviderBase<Object?>) return true;
 
         try {
-          // Initializating the provider, to make sure its dependencies are setup.
+          // Initializing the provider, to make sure its dependencies are setup.
           _container.readProviderElement(listenable);
         } catch (err) {
           // We don't care whether the provider is in error or not. We're just
@@ -647,7 +647,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu
               origin.dependencies!.contains(listenable.from) ||
               origin.dependencies!.contains(listenable),
           'The provider $origin tried to read $listenable, but it specified a '
-          "'dependendencies' list yet that list does not contain $listenable.\n\n"
+          "'dependencies' list yet that list does not contain $listenable.\n\n"
           "To fix, add $listenable to $origin's 'dependencies' parameter",
         );
 
@@ -793,7 +793,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu
     void Function(Object error, StackTrace stackTrace)? onError,
   }) {
     // TODO do we want to expose a way to close the subscription?
-    // TODO do we want a fireImmdiately?
+    // TODO do we want a fireImmediately?
 
     _onChangeSelfListeners ??= [];
     _onChangeSelfListeners!.add(listener);