docs: update documentation

owlsdepartment · Sep 15, 2022 · 8cec2f8 · 8cec2f8
1 parent c7f7bf3
commit 8cec2f8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -41,12 +41,12 @@ const { value } = await AndroidInsets.top();
 
 ### top()
 
-Get top offset of status bar
-
 ```typescript
 top() => Promise<TopReturn>
 ```
 
+Returns top offset of the status bar
+
 **Returns:** <code>Promise&lt;<a href="#topreturn">TopReturn</a>&gt;</code>
 
 --------------------

diff --git a/src/definitions.ts b/src/definitions.ts
@@ -1,4 +1,7 @@
 export interface AndroidInsetsPlugin {
+  /**
+   * Returns top offset of the status bar
+   */
   top(): Promise<TopReturn>;
 }