refactor: add file level comment

push-protocol · Sep 11, 2023 · 6349e9c · 6349e9c
1 parent 1470ab4
commit 6349e9c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/restapi/src/lib/spaceV2/joinAsSpeaker.ts b/packages/restapi/src/lib/spaceV2/joinAsSpeaker.ts
@@ -1,3 +1,8 @@
+/**
+ * @file joinAsSpeaker
+ * defines a function that allows a user to join a space as a speaker in the SpaceV2 implmentation
+ */
+
 import { get } from './get';
 import { SpaceV2 } from './SpaceV2';
 import { approve } from './approve';