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

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

Open
gromikkool opened this issue Oct 30, 2024 · 0 comments
Assignees
Labels
docs Add documentation around this topic

Comments

@gromikkool
Copy link

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

@amondnet amondnet self-assigned this Oct 31, 2024
@amondnet amondnet added the docs Add documentation around this topic label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Add documentation around this topic
Projects
None yet
Development

No branches or pull requests

2 participants