219 improve formatting options documentation #238
Conversation
…ocumentation where additional options are available.
|
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. |
There was a problem hiding this comment.
This file doesn't need to be tracked and may be different for different users. .vscode should be added to the .gitignore
| @@ -135,6 +135,179 @@ This ``additional_formatting`` parameter is best demonstrated by example: | |||
| } | |||
| ] | |||
|
|
|||
| Formatting methods | |||
There was a problem hiding this comment.
Can we make it clearer that this relates to the additional formatting? Maybe it could be a subsection of that section and make reference to it in the description paragraph
| * - Border colour | ||
| - {"border_color": "red"} | ||
| * - Bottom colour | ||
| - {"bottom_color":"red"} | ||
| * - Top colour | ||
| - {"top_color": "red"} | ||
| * - Left colour | ||
| - {"left_color": "red"} | ||
| * - Right colour | ||
| - {"right_color": "red"} |
There was a problem hiding this comment.
Consider varying the the value here to demonstrate different ways to specify colour, eg hex code etc
| .. | ||
|
|
||
| ----------- | ||
| Pattern formatting |
There was a problem hiding this comment.
What is pattern formatting?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
We've swapped from the iris to the penguins dataset for the package examples - can this be used here?
Related issues
Related to #219
Proposed Changes
Added documentation for all additional formatting options available, with examples demonstrating syntax.