219 improve formatting options documentation

[sarahcollyer]

Related issues
Related to #219

Proposed Changes
Added documentation for all additional formatting options available, with examples demonstrating syntax.

[sarahcollyer]

Need to debug set_center_across, shrink and text_wrap as we currently don't have them working in the additional_formatting method, but will add these to the backlog so that users can have access to the documentation for all other methods now.

[rowanhemsi]

Thanks so much for trying out and documenting the formatting options syntax! I've added a couple of comments but overall this is a great addition to the package

[rowanhemsi]

What is pattern formatting?

[rowanhemsi]

This doesn't really fit in with the other tests in the test directory, but I appreciate the easiest way to test the formatting customisation is by looking at it. Maybe this could be formalised in a similar way to the end-to-end test, where we compare programmatically generated outputs to a spreadsheet with known formatting?

[gisellerosetta]

These updates are going to be super. I had a couple of Qs/comments;

• Was it possible to update the additional formatting syntax test? Sorry I don't quite understand this part.
• For me, all the tests pass locally except 'test_end_to_end', it says some lists are different.
• Line 77 in test_additional_formatting_syntax.py - can you change this to penguins instead of iris?

Happy to chat! Thanks!
Giselle

[ldavies99]

These updates are going to be super. I had a couple of Qs/comments;

• Was it possible to update the additional formatting syntax test? Sorry I don't quite understand this part.
• For me, all the tests pass locally except 'test_end_to_end', it says some lists are different.
• Line 77 in test_additional_formatting_syntax.py - can you change this to penguins instead of iris?

Happy to chat! Thanks! Giselle

I updated it to use penguins data instead of iris but to change it to be like the end to end test would take a while so I was thinking we could do it in the next update since it doesn't change any functionality.
The tests all pass on my machine locally and it also seems to be passing on the CI so I'm not sure why it's failing on yours.
Good spot, I've changed the reference of iris to penguins.

[gisellerosetta]

Probably something weird my end then! This is really great. Thanks for these changes Luke. Approve! :D