Added comments to BaseConfig saving YAML

[wsp-mbuckley]

Describe Changes

Added optional datetime and custom comments to the top of YAML config files. Added optional comments to the write example method.

Address #57

Task Checklist

• [x] Have unittests been added (testing individual functions and their edge cases)
• [ ] Have integration tests been added (if applicable, to test modules of functionality)
• [x] Updated RELEASE.md to reflect changes in PR
• [ ] Have new dependencies been added?
  • [ ] Have they been added to either requirements.txt or requirements_dev.txt.
  • [ ] Have they been added to pyproject.toml

[wsp-mbuckley]

@isaac-tfn this will add date / time comments when saving to YAML by default and provides another parameter for custom comments if required, let me know what you think

[wsp-mbuckley]

Everything looks good apart from my comments on the typing not being backwards compatible.

Thanks for having a look, I've sorted that now so it should be ready to merge

[isaac-tfn]

There's a test failing which hasn't been touched in this PR (test_array_utils.TestSparseSum). Can you spot a reason why @BenTaylor-TfN?

[codecov[bot]]

Codecov Report

Patch coverage is 100.00% of modified lines.

Files Changed	Coverage
src/caf/toolkit/config_base.py	100.00%

:loudspeaker: Thoughts on this report? Let us know!.

[isaac-tfn]

There's a test failing which hasn't been touched in this PR (test_array_utils.TestSparseSum). Can you spot a reason why @BenTaylor-TfN?

I've just spotted there is a comment in the test that this is a known bug

[wsp-mbuckley]

There's a test failing which hasn't been touched in this PR (test_array_utils.TestSparseSum). Can you spot a reason why @BenTaylor-TfN?

I've just spotted there is a comment in the test that this is a known bug

Is this a linux specific issue because the test is passing fine on my machine

[BenTaylor-TfN]

Just spotted that this has also just happened on main, with some code that was previously fine before the PR was merged. See here: https://github.com/Transport-for-the-North/caf.toolkit/actions/runs/5953829958/job/16148999342

Here, it happened in python 3.11 and windows, must be something random causing it. Will try narrow it down shortly. Once I've logged this error, I'll re-run the test and it will likely pass.

[BenTaylor-TfN]

@wsp-mbuckley , sorted now

[wsp-mbuckley]

@BenTaylor-TfN or @isaac-tfn I think both of you are happy with this, please could one of you approve it and I'll merge it into main 😀