mobxjs/mobx.dart

Update API docs to be more exhaustive

Open

#249 opened on Aug 17, 2019

View on GitHub
 (1 comment) (4 reactions) (0 assignees)Dart (303 forks)batch import
docsgood first issuehelp wanted

Repository metrics

Stars
 (2,300 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The API docs for reactions do not show the various options available for autorun, reaction, when, asynWhen. This needs to be added.

Contributor guide

Research direction
Examine the existing API documentation files in the mobx.dart repository, likely in a 'docs' folder or inline in source code. Look at how other functions like `computed` or `observable` document their options. Then, for each of `autorun`, `reaction`, `when`, and `asyncWhen`, identify the available options (e.g., `name`, `delay`, `onError`) from the source code (e.g., in `lib/src/`). Add comprehensive documentation for these options following the existing style. The issue is clear but stale; no linked PRs or comments to consider.
Tech stack
dartflutter
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
familiarity with MobXDart documentation practicesreading source code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75