update docs

hzrd149 · Sep 28, 2024 · 29ce235 · 29ce235
1 parent 231e186
commit 29ce235
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/packages/core/src/observable/stateful.ts b/packages/core/src/observable/stateful.ts
@@ -7,7 +7,7 @@ export type StatefulObservable<T> = Observable<T> & {
   complete?: boolean;
 };
 
-/** Wraps an observable and makes it stateful */
+/** Wraps an {@link Observable} and makes it stateful */
 export function stateful<T extends unknown>(observable: Observable<T>, cleanup = false) {
   let subscription: ZenObservable.Subscription | undefined = undefined;
   let observers: ZenObservable.SubscriptionObserver<T>[] = [];

diff --git a/packages/core/src/observable/throttle.ts b/packages/core/src/observable/throttle.ts
@@ -1,5 +1,6 @@
 import Observable from "zen-observable";
 
+/** Throttles an {@link Observable} */
 export function throttle<T>(source: Observable<T>, interval: number): Observable<T> {
   return new Observable<T>((observer) => {
     let lastEmissionTime = 0;