[test] Clarify and cover orphaned functions distance() and time_diffs() in data_utils.py

[adity1raut]

Related Issue / Discussion:

• Fixes Issue [test] Clarify and cover orphaned functions distance() and time_diffs() in data_utils.py #167

Relates to discussion [link]

Changes:

Please list the central functionalities that have been changed:

• New class / file / …
• Modified class / file / …

Further Details:

Summary:

Please mention the relevant motivation and context of your changes and shortly describe the behaviour before and after your modifications.

• Confirmed via codebase-wide search that distance() and time_diffs()
  in data_utils.py are not imported or called anywhere in the main
  WRT package (compare.py uses import * but never calls them).
• Replaced the vague # TODO: Where is this function used? comments with
  proper docstrings that document parameters, return types, and include a
  .. warning:: noting the functions appear to be unused.
• Unit tests in TestDistance and TestTimeDiffs (from the previous PR)
  act as a regression guard until a removal decision is made.

Dependencies:

Please list new dependencies that are required for this modification.

Changes

• Modified WeatherRoutingTool/algorithms/data_utils.py — docstrings
  for distance() and time_diffs()
• Modified tests/test_data_utils.py — class docstrings for
  TestDistance and TestTimeDiffs updated to reference the unused status

PR Checklist:

In the context of this PR, I:

• have (already previously) filled the 52North Contributor License Agreement and received positive feedback on this matter
• have filled the 52North Contributor License Agreement and am waiting for feedback
• provide unit tests embedded in the WRT test framework (WeatherRoutingTool/tests) that allow the simple testing of the new/modified functionalities. All (previous and new) unit tests execute without new error messages.
• ensure that the code formatter runs without errors/warnings
• ensure that my changes follow the WRT’s guidelines for contributing at the time of the contribution

Please consider that PRs which do not meet the requirements specified in the checklist will not be evaluated. Also, PRs with no activities will be closed after a reasonable amount of time.

[kdemmich]

Hi @adity1raut, thank you for your PR. We appreciate the time and effort that was put into it. Please be aware that we require to follow 52 North's CLA guidelines for all PRs and, in particular, fill the 52°North Contributor License Agreement. As long as this has not been filled, I can not assign you to any issues or merge any PRs. Please don't hesitate to contact me in case of related questions.