aws / aws-sdk-cpp

AWS SDK for C++
Apache License 2.0
1.96k stars 1.05k forks source link

update doc and variable name for datetime ctor #2869

Closed sbiscigl closed 7 months ago

sbiscigl commented 7 months ago

Description of changes:

Got a customer reach out about the argument being named epoch_millis even thought it was processing the argument as seconds with a milliseconds mantissa. An example of this could be

int64_t timeMillis = 1708552755100;
Utils::DateTime millis(timeMillis);
std::cout << millis.ToGmtString(Utils::DateFormat::ISO_8601) << "\n";
double timeSeconds = 1708552755.100;
Utils::DateTime date(timeSeconds);
std::cout << date.ToGmtString(Utils::DateFormat::ISO_8601) << "\n";

updates the name and comment to make more clear about what the function is doing.

Check all that applies:

Check which platforms you have built SDK on to verify the correctness of this PR.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.