docs: Fixing incorrect method name in CapacitorGeolocation (#47)

Co-authored-by: pascholda1 <dev@pascholda.one> Co-authored-by: Joseph Pender <joey@ionic.io>
ionic-team · Apr 4, 2024 · 174f2fe · 174f2fe
1 parent 781a18e
commit 174f2fe
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 5 deletions.
diff --git a/.changeset/famous-beers-boil.md b/.changeset/famous-beers-boil.md
@@ -0,0 +1,5 @@
+---
+"@capacitor/background-runner": patch
+---
+
+Fixing incorrect method name in CapacitorGeolocation
diff --git a/README.md b/README.md
@@ -456,7 +456,7 @@ Get access to device location information.
 
 | Prop                     | Type                                                                                   | Description                          | Since |
 | ------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------ | ----- |
-| **`getCurrentLocation`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
+| **`getCurrentPosition`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
 
 
 #### GetCurrentPositionResult
@@ -488,4 +488,5 @@ They could be used if a native watch app is developed as a companion app to a Ca
 | **`updateWatchUI`**            | <code>(options: { watchUI: string; }) =&gt; void</code>                  | Replaces the current UI on the watch with what is specified here.                                                                                           |
 | **`updateWatchData`**          | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields                                                                          |
 
+
 </capacitor-api-docs>
diff --git a/packages/capacitor-plugin/API.md b/packages/capacitor-plugin/API.md
@@ -81,7 +81,7 @@ Get access to device location information.
 
 | Prop                     | Type                                                                                   | Description                          | Since |
 | ------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------ | ----- |
-| **`getCurrentLocation`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
+| **`getCurrentPosition`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
 
 
 #### GetCurrentPositionResult
@@ -113,4 +113,4 @@ They could be used if a native watch app is developed as a companion app to a Ca
 | **`updateWatchUI`**            | <code>(options: { watchUI: string; }) =&gt; void</code>                  | Replaces the current UI on the watch with what is specified here.                                                                                           |
 | **`updateWatchData`**          | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields                                                                          |
 
-</docgen-api>
+</docgen-api>
diff --git a/packages/capacitor-plugin/README.md b/packages/capacitor-plugin/README.md
@@ -456,7 +456,7 @@ Get access to device location information.
 
 | Prop                     | Type                                                                                   | Description                          | Since |
 | ------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------ | ----- |
-| **`getCurrentLocation`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
+| **`getCurrentPosition`** | <code>() =&gt; <a href="#getcurrentpositionresult">GetCurrentPositionResult</a></code> | Get the device's last known location | 1.0.0 |
 
 
 #### GetCurrentPositionResult
@@ -488,4 +488,5 @@ They could be used if a native watch app is developed as a companion app to a Ca
 | **`updateWatchUI`**            | <code>(options: { watchUI: string; }) =&gt; void</code>                  | Replaces the current UI on the watch with what is specified here.                                                                                           |
 | **`updateWatchData`**          | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields                                                                          |
 
+
 </capacitor-api-docs>
diff --git a/packages/capacitor-plugin/src/apis.ts b/packages/capacitor-plugin/src/apis.ts
@@ -253,7 +253,7 @@ export interface CapacitorGeolocation {
    * Get the device's last known location
    * @since 1.0.0
    */
-  getCurrentLocation: () => GetCurrentPositionResult;
+  getCurrentPosition: () => GetCurrentPositionResult;
 }
 
 /**