Fix typos and improve clarity in API documentation #480
+125
−125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@riderx is attempting to deploy a commit to the Ionic Team on Vercel. A member of the Team first needs to authorize it. |
Author
|
i used typos rust CLI to find them and validate all manually. |
…tion 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.
Author
|
@markemer this one is easier to review, I think as it's only text. |
There was a problem hiding this comment.
Pull request overview
This PR corrects typos and improves wording clarity across the Capacitor documentation site, spanning the current docs and multiple versioned doc sets (v2–v7), plus a few small inline-comment/style fixes in the site code.
Changes:
- Fixes repeated spelling mistakes and wording issues across guides, API references, and READMEs in
docs/andversioned_docs/. - Corrects several API-doc strings (including option/property names) and various instructional text in platform guides.
- Fixes minor typos in site source (TS/TSX), styling (SCSS), and a scripts comment.
Reviewed changes
Copilot reviewed 79 out of 80 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-v7/main/updating/6-0.md | Fixes “recommendations” typo in migration instructions. |
| versioned_docs/version-v7/main/updating/5-0.md | Fixes “recommendations” typo in migration instructions. |
| versioned_docs/version-v7/main/reference/config.md | Fixes “guarantees” spelling in Android scheme note. |
| versioned_docs/version-v7/main/ios/viewcontroller.md | Fixes “substituting” spelling in subclassing guidance. |
| versioned_docs/version-v7/main/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| versioned_docs/version-v7/main/guides/autofill-credentials.mdx | Fixes current-password typo in autocomplete examples. |
| versioned_docs/version-v7/apis/watch.md | Fixes multiple typos in watch plugin guide text. |
| versioned_docs/version-v7/apis/inappbrowser.md | Fixes iOS option name spelling in generated API docs. |
| versioned_docs/version-v7/apis/http.md | Fixes “received” spelling in response URL description. |
| versioned_docs/version-v7/apis/geolocation.md | Fixes “minimum” spelling in option description. |
| versioned_docs/version-v7/apis/action-sheet.md | Fixes “available” spelling in enum description. |
| versioned_docs/version-v7/README.md | Fixes versioned_docs path typo in versioning explanation. |
| versioned_docs/version-v6/main/vs-code-ext/z-advanced.md | Fixes “experimental” spelling in VS Code extension docs. |
| versioned_docs/version-v6/main/updating/6-0.md | Fixes “recommendations” typo in migration instructions. |
| versioned_docs/version-v6/main/updating/5-0.md | Fixes “recommendations” typo in migration instructions. |
| versioned_docs/version-v6/main/reference/config.md | Fixes “guarantees” spelling in Android scheme note. |
| versioned_docs/version-v6/main/ios/viewcontroller.md | Fixes “substituting” spelling in subclassing guidance. |
| versioned_docs/version-v6/main/ios/spm.md | Fixes “Capacitor” spelling in SPM section heading. |
| versioned_docs/version-v6/main/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| versioned_docs/version-v6/main/guides/autofill-credentials.mdx | Fixes current-password typo in autocomplete examples. |
| versioned_docs/version-v6/main/getting-started/vscode-extension.md | Fixes “separate” spelling in debugging guidance. |
| versioned_docs/version-v6/apis/watch.md | Fixes multiple typos in watch plugin guide text. |
| versioned_docs/version-v6/apis/inappbrowser.md | Fixes iOS option name spelling in generated API docs. |
| versioned_docs/version-v6/apis/http.md | Fixes “received” spelling in response URL description. |
| versioned_docs/version-v6/apis/geolocation.md | Fixes “minimum” spelling in option description. |
| versioned_docs/version-v6/apis/filesystem.md | Fixes “accessible” spelling in directory descriptions. |
| versioned_docs/version-v6/apis/action-sheet.md | Fixes “available” spelling in enum description. |
| versioned_docs/version-v6/README.md | Fixes versioned_docs path typo in versioning explanation. |
| versioned_docs/version-v5/main/vs-code-ext/z-advanced.md | Fixes “experimental” spelling in VS Code extension docs. |
| versioned_docs/version-v5/main/updating/5-0.md | Fixes “recommendations” typo in migration instructions. |
| versioned_docs/version-v5/main/reference/config.md | Fixes “guarantees” spelling in Android scheme note. |
| versioned_docs/version-v5/main/ios/viewcontroller.md | Fixes “substituting” spelling in subclassing guidance. |
| versioned_docs/version-v5/main/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| versioned_docs/version-v5/main/guides/autofill-credentials.mdx | Fixes current-password typo in autocomplete examples. |
| versioned_docs/version-v5/main/getting-started/vscode-extension.md | Fixes “separate” spelling in debugging guidance. |
| versioned_docs/version-v5/apis/watch.md | Fixes multiple typos in watch plugin guide text. |
| versioned_docs/version-v5/apis/http.md | Fixes “received” spelling in response URL description. |
| versioned_docs/version-v5/apis/filesystem.md | Fixes “accessible” spelling in directory descriptions. |
| versioned_docs/version-v5/apis/background-runner.md | Fixes “CapacitorWatch” spelling in watch integration section. |
| versioned_docs/version-v5/apis/action-sheet.md | Fixes “available” spelling in enum description. |
| versioned_docs/version-v5/README.md | Fixes versioned_docs path typo in versioning explanation. |
| versioned_docs/version-v4/main/vs-code-ext/z-advanced.md | Fixes “experimental” spelling in VS Code extension docs. |
| versioned_docs/version-v4/main/ios/viewcontroller.md | Fixes “substituting” spelling in subclassing guidance. |
| versioned_docs/version-v4/main/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| versioned_docs/version-v4/main/guides/autofill-credentials.mdx | Fixes current-password typo in autocomplete examples. |
| versioned_docs/version-v4/main/getting-started/vscode-extension.md | Fixes “separate” spelling in debugging guidance. |
| versioned_docs/version-v4/apis/http.md | Fixes “received” spelling in response URL description. |
| versioned_docs/version-v4/apis/filesystem.md | Fixes “accessible” spelling in directory descriptions. |
| versioned_docs/version-v4/apis/action-sheet.md | Fixes “available” spelling in enum description. |
| versioned_docs/version-v4/README.md | Fixes versioned_docs path typo in versioning explanation. |
| versioned_docs/version-v3/main/ios/viewcontroller.md | Fixes “substituting” spelling in subclassing guidance. |
| versioned_docs/version-v3/main/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| versioned_docs/version-v3/main/getting-started/vscode-extension.md | Fixes “separate” spelling in debugging guidance. |
| versioned_docs/version-v3/apis/filesystem.md | Fixes “accessible” spelling in directory descriptions. |
| versioned_docs/version-v3/apis/camera.md | Fixes “from” spelling in photo picking description. |
| versioned_docs/version-v3/apis/action-sheet.md | Fixes “available” spelling in enum description. |
| versioned_docs/version-v3/README.md | Fixes versioned_docs path typo in versioning explanation. |
| versioned_docs/version-v2/plugins/ios.md | Fixes “access” spelling in iOS plugin guide. |
| versioned_docs/version-v2/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| versioned_docs/version-v2/cordova/using-cordova-plugins.md | Fixes “Similar” spelling in Cordova plugins guide. |
| versioned_docs/version-v2/apis/push-notifications.md | Fixes “Capabilities” and “capabilities” spelling in section heading/body. |
| versioned_docs/version-v2/apis/filesystem.md | Fixes “accessible” spelling in directory descriptions. |
| versioned_docs/version-v2/apis/device.md | Fixes “version” spelling in appVersion description. |
| src/utils/hooks.ts | Fixes typo in inline comment (“instance”). |
| src/theme/TOC/index.tsx | Fixes typo in inline comment (“Responsive”). |
| src/components/page/react/PageStyles/index.module.scss | Fixes CSS property name typo (margin-bottom). |
| scripts/api-v6.mjs | Fixes typo in comment (“compatibility”). |
| docs/main/updating/6-0.md | Fixes “recommendations” and removes duplicated “in” in migration guidance. |
| docs/main/updating/5-0.md | Fixes “recommendations” and removes duplicated “in” in migration guidance. |
| docs/main/reference/config.md | Improves clarity of Android WebView minimum-version description; fixes “guarantees” typo. |
| docs/main/ios/viewcontroller.md | Fixes “substituting” spelling in subclassing guidance. |
| docs/main/guides/screen-orientation.md | Fixes “editing” spelling in Info.plist instructions. |
| docs/main/guides/autofill-credentials.mdx | Fixes current-password typo in autocomplete examples. |
| docs/apis/watch.md | Fixes multiple typos in watch plugin guide text. |
| docs/apis/local-notifications.md | Fixes duplicated “the” in a sentence about checking exact notification setting. |
| docs/apis/inappbrowser.md | Fixes iOS option name spelling in generated API docs. |
| docs/apis/http.md | Normalizes line endings in API docs text blocks. |
| docs/apis/background-runner.md | Fixes duplicated “the” in interval description. |
| docs/apis/action-sheet.md | Fixes “available” spelling in enum description. |
| docs/README.md | Fixes versioned_docs path typo in versioning explanation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **`allowInLineMediaPlayback`** | <code>boolean</code> | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. | | ||
| | **`surpressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. | | ||
| | **`suppressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. | | ||
| | **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. | |
There was a problem hiding this comment.
These API docs are generated from the plugin’s published README via the scripts/api*.mjs generators (they effectively copy the README content into this repo). Manually correcting an option name here is likely to be overwritten the next time the generation scripts are run; consider fixing the typo in the upstream @capacitor/inappbrowser README/docgen source (or adding a deterministic post-processing step in the generator) so the change persists.
Suggested change
| | **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. | | |
| | **`presentationStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. | |
Comment on lines
234
to
236
| | **`allowInLineMediaPlayback`** | <code>boolean</code> | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. | | ||
| | **`surpressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. | | ||
| | **`suppressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. | | ||
| | **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. | |
There was a problem hiding this comment.
These API docs appear to be generated output (copied from the plugin’s published README by the scripts/api-v6.mjs generator). Manual edits to option names here will likely be lost if the docs are regenerated; consider applying the fix in the upstream plugin README/docgen source (or in the generator) so it persists.
Comment on lines
258
to
260
| | **`allowInLineMediaPlayback`** | <code>boolean</code> | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. | | ||
| | **`surpressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. | | ||
| | **`suppressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. | | ||
| | **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. | |
There was a problem hiding this comment.
These API docs appear to be generated output (copied from the plugin’s published README by the scripts/api-v7.mjs generator). Manual edits to option names here will likely be lost if the docs are regenerated; consider applying the fix in the upstream plugin README/docgen source (or in the generator) so it persists.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Correct various typos and enhance the clarity of the API documentation to improve readability and understanding.