[SPARK-31940][SQL][DOCS] Document the default JVM time zone in to/fromJavaDate and legacy date formatters #28767
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Update comments for
DateTimeUtils
.toJavaDate
andfromJavaDate
, and for the legacy date formattersLegacySimpleDateFormatter
andLegacyFastDateFormatter
regarding to the default JVM time zone. The comments say that the default JVM time zone is used intentionally for backward compatibility with Spark 2.4 and earlier versions.Closes #28709
Why are the changes needed?
To document current behaviour of related methods in
DateTimeUtils
and the legacy date formatters. For example, correctness ofHiveResult.hiveResultString
andtoHiveString
is directly related to the same time zone used bytoJavaDate
andLegacyFastDateFormatter
.Does this PR introduce any user-facing change?
No
How was this patch tested?
By running the Scala style checker
./dev/scalastyle