docs: Add Component Locking section to README #112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@lmars I've just merged the Big Docs PR so you'll need to rebase your changes against that |
paddybyers
reviewed
Aug 24, 2023
paddybyers
reviewed
Aug 24, 2023
README.md
Outdated
| const req = await space.locks.acquire(id, { attributes }); | ||
| ``` | ||
|
|
||
| It throws an error if a lock request already exists for the given identifier with a status of `PENDING` or `LOCKED`. |
There was a problem hiding this comment.
Is it worth a specific comment here about recursive locking?
paddybyers
reviewed
Aug 24, 2023
dpiatek
force-pushed
the
locking-docs
branch
from
644501d
to
34f7c0d
Compare
Signed-off-by: Lewis Marshall <lewis.marshall@ably.com>
dpiatek
force-pushed
the
locking-docs
branch
from
34f7c0d
to
22b8d5d
Compare
Srushtika
requested changes
Sep 4, 2023
| ```ts | ||
| const locks = await space.locks.getAll(); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Can we possibly add sample response payloads in each of these methods?
There was a problem hiding this comment.
I don't think that's necessary - it's always an array of Locks, as signified by the type. I think that would just create more reading for the developer who'd look for differences in those payloads maybe.
dpiatek
force-pushed
the
locking-docs
branch
from
22b8d5d
to
d4745c9
Compare
dpiatek
approved these changes
Sep 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a Component Locking section to the README inline with the description from the PR which introduced the feature (#102).
The documentation is intentionally light on context and is subject to change over the coming weeks as we iterate on the feature.