apache / apache/couchdb-nano

Rename the atomic function as updateFunction

Open
#221 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
689
Forks
167
Avg merge
1h
Merged PRs (30d)
1

Description

The naming of the `atomic` function confuses users. I propose

- change the docs to use `updateFunction` instead of `atomic`
- retain `atomic` for compatibility for now.

Contributor guide

Open the contributing guide

Research direction

No file or test is named in the issue. Locate the documentation references to `atomic`, update them to `updateFunction`, retain `atomic` for compatibility, and verify that the documented API uses the new name while existing users remain supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.