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.

Sign up for GitHub

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

Doc improvements #2725

Merged
merged 5 commits into from
Jan 23, 2021
Merged

Doc improvements #2725

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e44ea4
docs: Document enumerability as discussed in #2641
mweststrate Jan 18, 2021
d76ccb2
docs: Document `proxy` option as discussed in #2717
mweststrate Jan 18, 2021
667659d
docs: use absolute urls in Readme, fixes #2685
mweststrate Jan 18, 2021
ac47354
Add changeset
mweststrate Jan 18, 2021
6c47843
Name fix
mweststrate Jan 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Name fix
  • Loading branch information
@mweststrate
mweststrate committed Jan 23, 2021
commit 6c478435319cf8e44e53ab8fea37825fd4bad10b
2 changes: 1 addition & 1 deletion docs/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ MobX requires that you declare your actions, although [`makeAutoObservable`](obs

2. By default, it is not allowed to change the state outside of actions. This helps to clearly identify in your code base where the state updates happen.

The `action` annotation should only be used on functions that intend to _modify_ the state. Functions that derive information (performing lookups or filtering data) should _not_ be marked as actions, to allow MobX to track their invocations. `flow` annotated members will be non-enumerable.
The `action` annotation should only be used on functions that intend to _modify_ the state. Functions that derive information (performing lookups or filtering data) should _not_ be marked as actions, to allow MobX to track their invocations. `action` annotated members will be non-enumerable.

## Examples

Expand Down