Skip to content

Commit

Permalink
Cleanup documentation and comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
aemous committed Sep 20, 2024
1 parent 7e05a73 commit 7629757
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
7 changes: 3 additions & 4 deletions awscli/customizations/s3/subcommands.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion awscli/customizations/s3/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'):
Expand Down

0 comments on commit 7629757

Please sign in to comment.