Skip to content
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

Open
wants to merge 12 commits into
base: dev
Choose a base branch
from

Conversation

sarahcollyer
Copy link

Related issues
Related to #219

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

@sarahcollyer sarahcollyer marked this pull request as ready for review August 20, 2024 15:02
@sarahcollyer
Copy link
Author

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.

Copy link
Collaborator

@rowanhemsi rowanhemsi left a 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

.vscode/settings.json Outdated Show resolved Hide resolved
docs/source/doc.gptable.rst Show resolved Hide resolved
docs/source/doc.gptable.rst Outdated Show resolved Hide resolved
..

-----------
Pattern formatting
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is pattern formatting?

Copy link
Collaborator

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?

gptables/test/iris.csv Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants