From 4284a544bd47d2809b1a25bf1cd1300b572ccddf Mon Sep 17 00:00:00 2001 From: aemous Date: Fri, 20 Sep 2024 11:17:52 -0400 Subject: [PATCH] Cleanup documentation and comments. --- awscli/customizations/s3/subcommands.py | 7 +++---- awscli/customizations/s3/utils.py | 1 - 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/awscli/customizations/s3/subcommands.py b/awscli/customizations/s3/subcommands.py index d4aeea22bbfde..2e39b32496a8a 100644 --- a/awscli/customizations/s3/subcommands.py +++ b/awscli/customizations/s3/subcommands.py @@ -484,13 +484,12 @@ CHECKSUM_MODE = { 'name': 'checksum-mode', 'choices': ['ENABLED'], 'help_text': 'To retrieve the checksum, this mode must be enabled.' -} # TODO finalize help text +} CHECKSUM_ALGORITHM = { 'name': 'checksum-algorithm', 'choices': ['CRC32', 'SHA256', 'SHA1', 'CRC32C'], - 'help_text': 'Indicates the algorithm used to create the checksum for the object when you use the SDK. ' - 'This header will not provide any additional functionality if you don’t use the SDK.' -} # TODO truncated some of the doc description from low-level api until i see exactly how this affects things. + 'help_text': 'Indicates the algorithm used to create the checksum for the object.' +} TRANSFER_ARGS = [DRYRUN, QUIET, INCLUDE, EXCLUDE, ACL, FOLLOW_SYMLINKS, NO_FOLLOW_SYMLINKS, NO_GUESS_MIME_TYPE, diff --git a/awscli/customizations/s3/utils.py b/awscli/customizations/s3/utils.py index 712f3ee3abe97..72777b62e00b1 100644 --- a/awscli/customizations/s3/utils.py +++ b/awscli/customizations/s3/utils.py @@ -549,7 +549,6 @@ def _set_checksum_mode_param(cls, request_params, cli_params): if cli_params.get('checksum_mode'): request_params['ChecksumMode'] = cli_params['checksum_mode'] - # TODO we might want to pluralize this and parse each algorithm's header if desired @classmethod def _set_checksum_algorithm_param(cls, request_params, cli_params): if cli_params.get('checksum_algorithm'):