(Async)NotifierProvider documentation example update

[stephane-archer]

Most examples in the documentation present a quite advanced programming style, which makes it unusable for beginners.
In many cases, ChatGPT is the best way to decipher the examples.
The goal should be to make the documentation accessible without prior knowledge.

for example, https://riverpod.dev/docs/providers/notifier_provider is not clear.
With the presence of @freezed with _$Todo extends _$Todos

Here is my simplified example for this page that comes from my codebase and doesn't use advance features

import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:shared_preferences/shared_preferences.dart';

class ConvertionStats {
  final int inputFileSize;
  final int outputFileSize;

  ConvertionStats(this.inputFileSize, this.outputFileSize);
}

class AllTimeConvertionStats extends AsyncNotifier<ConvertionStats> {
  @override
  Future<ConvertionStats> build() async {
    // Load initial state from SharedPreferences.
    final prefs = await SharedPreferences.getInstance();
    final inputFileSize = prefs.getInt('allTimeInputFileSize') ?? 0;
    final outputFileSize = prefs.getInt('allTimeOutputFileSize') ?? 0;
    return ConvertionStats(inputFileSize, outputFileSize);
  }

  Future<void> updateStats(ConvertionStats newStats) async {
    final prefs = await SharedPreferences.getInstance();

    // Persist to SharedPreferences.
    await prefs.setInt('allTimeInputFileSize', newStats.inputFileSize);
    await prefs.setInt('allTimeOutputFileSize', newStats.outputFileSize);

    // Update the state.
    state = AsyncValue.data(newStats);
  }
}

final allTimeConvertionStatsProvider =
    AsyncNotifierProvider<AllTimeConvertionStats, ConvertionStats>(
  () => AllTimeConvertionStats(),
);

How to use it:

final statsAsync = ref.watch(allTimeConvertionStatsProvider);

return statsAsync.when(
  data: (stats) => Text(
    'Input: ${stats.inputFileSize}, Output: ${stats.outputFileSize}',
  ),
  loading: () => CircularProgressIndicator(),
  error: (error, stack) => Text('Error: $error'),
);

How to update the state

final notifier = ref.read(allTimeConvertionStatsProvider.notifier);

notifier.updateStats(ConvertionStats(newInputSize, newOutputSize));

I think this example shows a much more accessible code for AsyncNotifier

[rrousselGit]

for example, riverpod.dev/docs/providers/notifier_provider is not clear.
With the presence of @freezed with _$Todo extends _$Todos

Code-generation can be disabled in the sidebar. There's already a variant of all snippets without any of these :)

Code-generation is the recommended approach, and as such the default syntax shown by the docs. But the alternative is already present

[stephane-archer]

@rrousselGit I would consider code generation an advanced feature, so I would not make it the default, because from my understanding it's only for convenience and requires a good level of knowledge of the provider package. To me, it should default to user-friendly, and have an advanced mode