Skip to content

Commit 8f682ce

Browse files
committed
fix(docs): correct typos and improve clarity in various API documentation files
- Fixed spelling errors and improved descriptions in action-sheet, filesystem, geolocation, http, inappbrowser, watch, autofill-credentials, games, screen-orientation, spm, viewcontroller, and config documentation. - Updated "availabe" to "available" in action-sheet. - Updated "accesible" to "accessible" in filesystem. - Updated "minumum" to "minimum" in geolocation. - Updated "recieved" to "received" in http. - Updated "surpress" to "suppress" in inappbrowser. - Updated "communcation" to "communication" in watch. - Updated "recomendations" to "recommendations" in migration guides. - Updated "guarentees" to "guarantees" in config. - Updated "Capactior" to "Capacitor" in watch. - Updated "wiht" to "with" in games.
1 parent 0d0bfee commit 8f682ce

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+102
-102
lines changed

scripts/api-v6.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ function createApiPage(plugin, readme, pkgJson) {
6868
: plugin.editApiUrl;
6969
const sidebarLabel = toTitleCase(pluginId);
7070

71-
// // escape right curly brace in inline code blocks for MDX v3 compatability
71+
// // escape right curly brace in inline code blocks for MDX v3 compatibility
7272
// const regexp = /[<|(&lt;)]code>(.*)[<|(&lt;)]\/code>/g;
7373

7474
// readme = readme.replace(regexp, (result) => {

src/components/page/react/PageStyles/index.module.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
padding: 50px 0px;
2020
}
2121
.main-flex h1 {
22-
margin-botton: 0px;
22+
margin-bottom: 0px;
2323
}
2424
.main-flex ul {
2525
padding-left: 0;

src/theme/TOC/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export default function TOC({ ...props }) {
4040
target={activeAd.ad_url.target}
4141
// onClick={e => trackClick(activeAd.ad_id, e)}
4242
>
43-
{/* Reponsive image since Prismic supports it out of the box */}
43+
{/* Responsive image since Prismic supports it out of the box */}
4444
<picture>
4545
<source media="(min-width: 37.5em)" src={activeAd.ad_image.url} />
4646
<source src={activeAd.ad_image['1x'].url} />

src/utils/hooks.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const useScript = (src: string) => {
1313
return;
1414
}
1515
// Fetch existing script element by src
16-
// It may have been added by another intance of this hook
16+
// It may have been added by another instance of this hook
1717
let script = document.querySelector(`script[src="${src}"]`) as HTMLScriptElement;
1818
if (!script) {
1919
// Create script

versioned_docs/version-v2/apis/device.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Get the device's current language locale code
103103
| **`model`** | <code>string</code> | The device model. For example, "iPhone" |
104104
| **`platform`** | <code>"ios" \| "android" \| "electron" \| "web"</code> | The device platform (lowercase). |
105105
| **`uuid`** | <code>string</code> | The UUID of the device as available to the app. This identifier may change on modern mobile platforms that only allow per-app install UUIDs. |
106-
| **`appVersion`** | <code>string</code> | The current bundle verison of the app |
106+
| **`appVersion`** | <code>string</code> | The current bundle version of the app |
107107
| **`appBuild`** | <code>string</code> | The current bundle build of the app |
108108
| **`appId`** | <code>string</code> | The bundle id of the app |
109109
| **`appName`** | <code>string</code> | The display name of the app |

versioned_docs/version-v2/apis/filesystem.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,11 +476,11 @@ Copy a file or directory
476476

477477
| Members | Value | Description |
478478
| --------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
479-
| **`Documents`** | <code>"DOCUMENTS"</code> | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` |
479+
| **`Documents`** | <code>"DOCUMENTS"</code> | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` |
480480
| **`Data`** | <code>"DATA"</code> | The Data directory On iOS it will use the Documents directory On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. |
481481
| **`Cache`** | <code>"CACHE"</code> | The Cache directory Can be deleted in cases of low memory, so use this directory to write app-specific files that your app can re-create easily. |
482482
| **`External`** | <code>"EXTERNAL"</code> | The external directory On iOS it will use the Documents directory On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. |
483-
| **`ExternalStorage`** | <code>"EXTERNAL_STORAGE"</code> | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` |
483+
| **`ExternalStorage`** | <code>"EXTERNAL_STORAGE"</code> | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` |
484484

485485
#### FilesystemEncoding
486486

versioned_docs/version-v2/apis/push-notifications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ canonicalUrl: https://capacitorjs.com/docs/apis/push-notifications
1313

1414
The Push Notifications API provides methods for registering a device to receive notifications from a server, along with processing received notifications and responding to them. In contrast, the [Local Notifications](/apis/local-notifications.md) API provides means for offline, local notification scheduling and processing.
1515

16-
## Enabling Push Notifications Capabilites
16+
## Enabling Push Notifications Capabilities
1717

1818
On iOS you must enable Push Notifications Capabilities in your project to enable the Push Notifications plugin to work. To do so, go to the `Capabilities` section of the app project and switch the `Push Notifications` button from `OFF` to the `ON` position.
1919

20-
This change adds the push capabilites to the app and creates an entitlements file in the project.
20+
This change adds the push capabilities to the app and creates an entitlements file in the project.
2121

2222
![Enabling Push Notifications Capabilities](../../../static/img/v3/docs/ios/enable-push-capabilities.png)
2323

versioned_docs/version-v2/cordova/using-cordova-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ npx cap sync
4141

4242
## Updating Ionic Native Plugins
4343

44-
Similiar to the installation steps. Update the Ionic Native JavaScript library, remove then re-add the Cordova plugin, then update your project:
44+
Similar to the installation steps. Update the Ionic Native JavaScript library, remove then re-add the Cordova plugin, then update your project:
4545

4646
```bash
4747
npm install @ionic-native/javascript-package-name@2

versioned_docs/version-v2/guides/screen-orientation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co
1818

1919
iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads.
2020

21-
If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads:
21+
If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads:
2222

2323
```
2424
<key>UISupportedInterfaceOrientations</key>

versioned_docs/version-v2/plugins/ios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ public class MyPlugin: CAPPlugin {
120120

121121
### Presenting Native Screens
122122

123-
To present a Native Screen over the Capacitor screen we need to acces the Capacitor's View Controller.
123+
To present a Native Screen over the Capacitor screen we need to access the Capacitor's View Controller.
124124
To access the Capacitor's View Controller, we have to use the `CAPBridge` object available on `CAPPlugin` class.
125125

126126
We can use the `UIViewController` to present Native View Controllers over it like this:

0 commit comments

Comments
 (0)