-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
219 improve formatting options documentation #238
base: dev
Are you sure you want to change the base?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is pattern formatting?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.