Merge pull request #942 from steveukx/chore/typos

Chore/typos

docs/PLUGIN-UNSAFE-ACTIONS.md

@@ -1,7 +1,7 @@
 ## Unsafe Actions
 
 As `simple-git` passes generated arguments through to a child process of the calling node.js process, it is recommended
-that any parameter sourced from user input is validated before being passed to the `simple-git` api.
+that any parameter sourced from user input is validated before being passed to the `simple-git` API.
 
 In some cases where there is an elevated potential for harm `simple-git` will throw an exception unless you have
 explicitly opted in to the potentially unsafe action.

examples/git-version.md

@@ -1,7 +1,7 @@
-## Check if git is installed
+## Check if `git` is installed
 
 To check if `git` (or the `customBinary` of your choosing) is accessible, use the
-`git.version()` api:
+`git.version()` API:
 
 ```typescript
 import { simpleGit } from 'simple-git';
@@ -11,10 +11,10 @@ if (!installed) {
   throw new Error(`Exit: "git" not available.`);
 }
 
-// ... continue using git commands here
+// ... continue using Git commands here
 ```
 
-## Check for a specific version of git
+## Check for a specific version of `git`
 
 Using the `git.version()` interface, you can query for the current `git` version
 information split by `major`, `minor` and `patch`:
@@ -28,5 +28,5 @@ if (lt(String(versionResult), '2.1.0')) {
   throw new Error(`Exit: "git" must be at least version 2.1.0.`);
 }
 
-// ... continue using git commands here compatible with 2.1.0 or higher
+// ... continue using Git commands here that are compatible with 2.1.0 or higher
 ```

simple-git/CHANGELOG.md

@@ -356,8 +356,8 @@
 
 ### Bug Fixes
 
--  add types and tests for the documented .exec api ([#631](https://www.github.com/steveukx/git-js/issues/631)) ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8))
--  add types and tests for the documented `.exec` api ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8))
+-  add types and tests for the documented .exec API ([#631](https://www.github.com/steveukx/git-js/issues/631)) ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8))
+-  add types and tests for the documented `.exec` API ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8))
 -  updates the documentation for `mergeFromTo` to more closely represent its functionality (see [#50](https://www.github.com/steveukx/git-js/issues/50) for the original requirement). ([dd2244e](https://www.github.com/steveukx/git-js/commit/dd2244e1bd84911668b0d23184afb736dc5386b8))
 
 ## [2.39.0](https://www.github.com/steveukx/git-js/compare/v2.38.1...v2.39.0) (2021-05-13)

simple-git/readme.md

@@ -378,7 +378,7 @@ in v2 (deprecation notices were logged to `stdout` as `console.warn` in v2).
 ## git show
 
 - `.show(options)` show various types of objects for example the file content at a certain commit. `options` is the single value string or any [options](#how-to-specify-options) supported by the [git show](https://git-scm.com/docs/git-show) command.
-- `.showBuffer(options)` same as the `.show` api, but returns the Buffer content directly to allow for showing binary file content.
+- `.showBuffer(options)` same as the `.show` API, but returns the Buffer content directly to allow for showing binary file content.
 
 ## git status
 
@@ -634,7 +634,7 @@ the full list of verbose logging options to use with the
 There are a few potential reasons:
 
 -  `git` isn't available as a binary for the user running the main `node` process, custom paths to the binary can be used
-   with the `.customBinary(...)` api option.
+   with the `.customBinary(...)` API option.
 
 -  the working directory passed in to the main `simple-git` function isn't accessible, check it is read/write accessible
    by the user running the `node` process. This library uses
@@ -684,7 +684,7 @@ from `core-js` - see [Legacy Node Versions](https://github.com/steveukx/git-js/b
 
 ### using a pathspec to limit the scope of the task
 
-If the `simple-git` api doesn't explicitly limit the scope of the task being run (ie: `git.add()` requires the files to
+If the `simple-git` API doesn't explicitly limit the scope of the task being run (ie: `git.add()` requires the files to
 be added, but `git.status()` will run against the entire repo), add a `pathspec` to the command using trailing options:
 
 ```typescript

simple-git/typings/simple-git.d.ts

@@ -530,7 +530,7 @@ export interface SimpleGit extends SimpleGitBase {
 
    /**
     * Calls the supplied `handle` function at the next step in the chain, used to run arbitrary functions synchronously
-    * before the next task in the git api.
+    * before the next task in the git API.
     */
    exec(handle: () => void): Response<void>;