Skip to content

Cleanup some JSDocs related to observables #228739

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Cleanup some JSDocs related to observables #228739

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/vs/base/common/observableInternal/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export interface IObservableWithChange<T, TChange = unknown> {
export interface IObserver {
/**
* Signals that the given observable might have changed and a transaction potentially modifying that observable started.
* Before the given observable can call this method again, is must call {@link IObserver.endUpdate}.
* Every call of this method must be eventually accompanied with the corresponding {@link IObserver.endUpdate} call.
*
* Implementations must not get/read the value of other observables, as they might not have received this event yet!
* The method {@link IObservable.reportChanges} can be used to force the observable to report the changes.
Expand Down Expand Up @@ -172,8 +172,8 @@ export interface ISettable<T, TChange = void> {

export interface ITransaction {
/**
* Calls {@link Observer.beginUpdate} immediately
* and {@link Observer.endUpdate} when the transaction ends.
* Calls {@link IObserver.beginUpdate} immediately
* and {@link IObserver.endUpdate} when the transaction ends.
*/
updateObserver(observer: IObserver, observable: IObservableWithChange<any, any>): void;
}
Expand Down