Skip to content
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

Improve code doc #47

Open
RicardoRB opened this issue Oct 15, 2021 · 0 comments
Open

Improve code doc #47

RicardoRB opened this issue Oct 15, 2021 · 0 comments

Comments

@RicardoRB
Copy link

Unfortunately, it isn't totally clear what the parameters do.

It would be great to explain it better in the code docs.

  /// Configure your app with [Momentum] root widget.
  ///
  /// The parameter `child` is not required for *unit testing*.
  factory Momentum({
    Key? key,
    Future<void> Function()? initializer,
    Widget? child,
    Widget? appLoader,
    required List<MomentumController> controllers,
    List<MomentumService>? services,
    ResetAll? onResetAll,
    bool? disabledPersistentState,
    bool? enableLogging,
    int? maxTimeTravelSteps,
    bool? lazy,
    int? minimumBootstrapTime,
    BootstrapStrategy? strategy,
    PersistSaver? persistSave,
    PersistGet? persistGet,
    String? testSessionName,
    void Function()? restartCallback,
  })
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant