Cleanup some JSDocs related to observables #228739
Open
+3
−3
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.
Mainly, this PR proposes to relax the constraint
in the JSDoc for the
IObserver.beginUpdate
method.All existing observer implementations in VS Code are resilient to repeated calls of
beginUpdate
for the same observable, provided that each call is eventually accompanied with the correspondingendUpdate
call. (All the implementations are based on using an update counter.)Whereas the current implementation of
ObservableValue
does not satisfy this constraint when itsset
method is repeatedly called with the same transaction. (In that case, it will repeatedly calltx.updateObserver(observer, this)
, which will repeatedly callobserver.beginUpdate(observable)
.)