Add title argument to plotting function

[chinandrew]

Based off #361, so based for this PR should be switched to main and merged after it. Fixes #360.

Summary of changes:

• Add an optional title argument to the plotting function.
• Add test.
• Add some docstrings in the test mocks that I thought might be useful.

[capnrefsmmat]

Hmm. Is there a way to set a subtitle? Because it seems like a good strategy would be to take a custom title and let the subtitle be date. Otherwise, if you set a title, the date doesn't get displayed at all, right?

[chinandrew]

Hmm. Is there a way to set a subtitle? Because it seems like a good strategy would be to take a custom title and let the subtitle be date. Otherwise, if you set a title, the date doesn't get displayed at all, right?

matplotlib has a suptitle() (yes with a p and not b) that places a title centered on the figure, but it doesn't look great

Alternatively you can add a \n and that will lead to a second line.

Is it a big problem if there's no date? A user always has the option to add the date, and if we force it in the subtitle and they don't want it, that could be annoying. The one case where I could see it making sense is when you pass in a df with multiple dates and it uses the most recent time value, having it tell you that date could be useful. However, we could also achieve that with a message/warning of some sort.

[capnrefsmmat]

Ah, sorry, I was thinking of the animation method for some reason, maybe because it was being discussed on Slack. There it's important to have a date appear somewhere, because otherwise you have no idea which frame corresponds to what date.

[chinandrew]

Ah, sorry, I was thinking of the animation method for some reason, maybe because it was being discussed on Slack. There it's important to have a date appear somewhere, because otherwise you have no idea which frame corresponds to what date.

Good point. Maybe we add an optional add_date argument that adds f"\n{date}" to the end of a provided title?

[dshemetov]

This looks like a backwards-compatible change. Do we want to fix and merge or close? @capnrefsmmat