Skip to content

Commit 6614e5c

Browse files
committed
chore: address PR comments
1 parent 2f4688b commit 6614e5c

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ clean: ## Clean the temporary files.
1212
rm -rf .pytest_cache
1313
rm -rf tests/__pycache__
1414
rm -rf .coverage
15+
rm -rf megalinter-reports/
1516
rm -rf output
1617
rm -rf debug.log
1718

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ When deploying to AWS, this should be set to `false` to avoid files being writte
2727

2828
#### `write_data_locally`
2929

30-
If set to `true`, the tool will skip writing to S3 and instead write data for copilot teams, historic usage, and teams history to `local_data`.
30+
If set to `true`, the tool will skip writing to the appropriate AWS S3 bucket and instead write data for copilot teams, historic usage, and teams history to `local_data`.
3131

3232
**When deploying to AWS, this must be set to `false` to ensure the tool writes to AWS.**
3333

src/main.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def get_copilot_team_date(gh: github_api_toolkit.github_interface, page: int) ->
9393
team_html_url = team.get("html_url", "")
9494

9595
logger.info(
96-
"Team % has Copilot data",
96+
"Team %s has Copilot data",
9797
team_name,
9898
extra={
9999
"team_name": team_name,
@@ -123,7 +123,7 @@ def get_and_update_historic_usage(
123123
Args:
124124
s3 (boto3.client): An S3 client.
125125
gh (github_api_toolkit.github_interface): An instance of the github_interface class.
126-
write_data_locally (bool): Whether to write data locally instead of to S3.
126+
write_data_locally (bool): Whether to write data locally instead of to an S3 bucket.
127127
128128
Returns:
129129
tuple: A tuple containing the updated historic usage data and a list of dates added.
@@ -178,7 +178,7 @@ def get_and_update_copilot_teams(
178178
Args:
179179
s3 (boto3.client): An S3 client.
180180
gh (github_api_toolkit.github_interface): An instance of the github_interface class.
181-
write_data_locally (bool): Whether to write data locally instead of to S3.
181+
write_data_locally (bool): Whether to write data locally instead of to an S3 bucket.
182182
183183
Returns:
184184
list: A list of GitHub Teams with Copilot Data.

0 commit comments

Comments
 (0)