Skip to content

Commit 19bb117

Browse files
committed
Consistent casing - API, Git and git
1 parent 91ae258 commit 19bb117

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

docs/PLUGIN-UNSAFE-ACTIONS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Unsafe Actions
22

33
As `simple-git` passes generated arguments through to a child process of the calling node.js process, it is recommended
4-
that any parameter sourced from user input is validated before being passed to the `simple-git` api.
4+
that any parameter sourced from user input is validated before being passed to the `simple-git` API.
55

66
In some cases where there is an elevated potential for harm `simple-git` will throw an exception unless you have
77
explicitly opted in to the potentially unsafe action.

examples/git-version.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Check if Git is installed
1+
## Check if `git` is installed
22

33
To check if `git` (or the `customBinary` of your choosing) is accessible, use the
44
`git.version()` API:
@@ -14,7 +14,7 @@ if (!installed) {
1414
// ... continue using Git commands here
1515
```
1616

17-
## Check for a specific version of Git
17+
## Check for a specific version of `git`
1818

1919
Using the `git.version()` interface, you can query for the current `git` version
2020
information split by `major`, `minor` and `patch`:

simple-git/CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,8 @@
356356

357357
### Bug Fixes
358358

359-
- 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))
360-
- add types and tests for the documented `.exec` api ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8))
359+
- 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))
360+
- add types and tests for the documented `.exec` API ([c9207da](https://www.github.com/steveukx/git-js/commit/c9207da1d8196193b580c5d4fed6101e5c4d4ff8))
361361
- 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))
362362

363363
## [2.39.0](https://www.github.com/steveukx/git-js/compare/v2.38.1...v2.39.0) (2021-05-13)

simple-git/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ in v2 (deprecation notices were logged to `stdout` as `console.warn` in v2).
378378
## git show
379379

380380
- `.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.
381-
- `.showBuffer(options)` same as the `.show` api, but returns the Buffer content directly to allow for showing binary file content.
381+
- `.showBuffer(options)` same as the `.show` API, but returns the Buffer content directly to allow for showing binary file content.
382382

383383
## git status
384384

@@ -634,7 +634,7 @@ the full list of verbose logging options to use with the
634634
There are a few potential reasons:
635635

636636
- `git` isn't available as a binary for the user running the main `node` process, custom paths to the binary can be used
637-
with the `.customBinary(...)` api option.
637+
with the `.customBinary(...)` API option.
638638

639639
- the working directory passed in to the main `simple-git` function isn't accessible, check it is read/write accessible
640640
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
684684

685685
### using a pathspec to limit the scope of the task
686686

687-
If the `simple-git` api doesn't explicitly limit the scope of the task being run (ie: `git.add()` requires the files to
687+
If the `simple-git` API doesn't explicitly limit the scope of the task being run (ie: `git.add()` requires the files to
688688
be added, but `git.status()` will run against the entire repo), add a `pathspec` to the command using trailing options:
689689

690690
```typescript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ export interface SimpleGit extends SimpleGitBase {
530530

531531
/**
532532
* Calls the supplied `handle` function at the next step in the chain, used to run arbitrary functions synchronously
533-
* before the next task in the git api.
533+
* before the next task in the git API.
534534
*/
535535
exec(handle: () => void): Response<void>;
536536

0 commit comments

Comments
 (0)