Skip to content

Inconsistent documentation: DartDoc Describes "reaction" and "autorun" behavior incorrectly #1023

@gromikkool

Description

@gromikkool

The documentation on the website and in DartDoc describes the behavior of reaction and autorun differently. Specifically:

In DartDoc, reaction performs actions that autorun should handle.
Similarly, autorun executes actions intended for reaction.
This inconsistency causes confusion, as it makes it unclear which function should be used for specific cases.

Expected Behavior: The reaction and autorun descriptions should match across both the website and DartDoc. Each function's purpose and behavior need to be clearly and accurately described to avoid misunderstandings.

Steps to Reproduce:

  1. Compare the documentation for reaction and autorun on the official website with the DartDoc descriptions.
  2. Notice the discrepancy in the behavior explanation.

Environment:
Dart SDK version: 3.5.0 (stable)
Package version: (mobx: ^2.3.3+2)
image
image

Metadata

Metadata

Assignees

Labels

docsAdd documentation around this topic

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions