From 2d31f93f3ae62b93367f16418b1b652e0b29efe1 Mon Sep 17 00:00:00 2001 From: Muiris Woulfe Date: Wed, 18 Sep 2024 18:01:50 +0100 Subject: [PATCH] Refining wording --- README.md | 12 ++++++------ docs/azure-pipelines-task.md | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aab27162..cfdd218b 100644 --- a/README.md +++ b/README.md @@ -150,8 +150,8 @@ Instructions on using the action within Azure Pipelines can be found ## Git History -Depending on the nature of your repo history, it may be necessary to fetch Git -history during checkout. This can be done by updating the `actions/checkout` +Depending on the nature of your repository history, it may be necessary to fetch +Git history during checkout. This can be done by updating the `actions/checkout` step: ```YAML @@ -160,10 +160,10 @@ step: ``` In many cases, `fetch-depth` will not be required so it is recommended not to -set this unless the task explicitly requests it. It may also be possible to set -this to a value greater than 0 if you only require a partial history, but it can -be difficult to determine a value that will work consistently, due to the nature -of Git history. +set this unless the action explicitly requests it. It may also be possible to +set this to a value greater than 0 if you only require a partial history, but it +can be difficult to determine a value that will work consistently, due to the +nature of Git history. ## Troubleshooting diff --git a/docs/azure-pipelines-task.md b/docs/azure-pipelines-task.md index 0041f33a..71b80805 100644 --- a/docs/azure-pipelines-task.md +++ b/docs/azure-pipelines-task.md @@ -96,8 +96,8 @@ name `PR_METRICS_ACCESS_TOKEN` cannot be altered. ## Git History -Depending on the nature of your repo history, it may be necessary to fetch Git -history during checkout. This can be done by updating the `checkout` step: +Depending on the nature of your repository history, it may be necessary to fetch +Git history during checkout. This can be done by updating the `checkout` step: ```YAML - checkout: self