Skip to content

Commit 6f7dfbd

Browse files
committed
Add link to OAuth2 functions to relevant pages
1 parent 97f3a28 commit 6f7dfbd

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

docs/clone.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Clone a repository
2222
| emitter | EventEmitter = undefined | Listeners to this EventEmitter can receive 'progress' and 'message' events. |
2323
| return | Promise\<void\> | Resolves successfully when clone completes |
2424

25+
> Need to use a Personal Access Token or OAuth? See the [`utils.auth`](utils_auth.html) and [`utils.oauth2`](utils_oauth2.html) functions.
26+
2527
To monitor progress, create an EventEmitter, add listeners, and pass into the function as the `emitter` argument.
2628

2729
| event | type | description |

docs/fetch.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Fetch commits from a remote repository
2222
| emitter | EventEmitter = undefined | Listeners to this EventEmitter can receive 'progress' and 'message' events. |
2323
| return | Promise\<FetchResponse\> | Resolves successfully when fetch completes |
2424

25+
> Need to use a Personal Access Token or OAuth? See the [`utils.auth`](utils_auth.html) and [`utils.oauth2`](utils_oauth2.html) functions.
26+
2527
The object returned has the following schema:
2628

2729
```ts

docs/push.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Push a branch
1616
| emitter | EventEmitter = undefined | Listeners to this EventEmitter can receive 'message' events. |
1717
| return | Promise\<PushResponse\> | Resolves successfully when push completes with a detailed description of the operation from the server. |
1818

19+
> Need to use a Personal Access Token or OAuth? See the [`utils.auth`](utils_auth.html) and [`utils.oauth2`](utils_oauth2.html) functions.
20+
1921
The push command returns an object that describes the result of the attempted push operation.
2022
*Notes:* If there were no errors, then there will be no `errors` property. There can be a mix of `ok` messages and `errors` messages.
2123

0 commit comments

Comments
 (0)