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

Fix GitHub-Flavoured Markdown for narrow columns #296

Merged
merged 4 commits into from Apr 9, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 2, 2024

Fixes #295.

Code

from prettytable import MARKDOWN, PrettyTable

table = PrettyTable()
table.set_style(MARKDOWN)
table.add_row([1, "Adelaide"])
table.add_row([2, "Brisbane"])
table.add_row([3, "Darwin"])
table.add_row([4, "Hobart"])
table.add_row([5, "Sydney"])
table.add_row([6, "Melbourne"])
table.add_row([7, "Perth"])

for first_header in ("", "A", "AB", "ABC"):
    table.field_names = [first_header, "City name"]

    for align in ("l", "c", "r"):
        table.align = align

        print(table)
        print()

Before

|   | City name |
| :-| :---------|
| 1 | Adelaide  |
| 2 | Brisbane  |
| 3 | Darwin    |
| 4 | Hobart    |
| 5 | Sydney    |
| 6 | Melbourne |
| 7 | Perth     |

|   | City name |
| : | :-------: |
| 1 |  Adelaide |
| 2 |  Brisbane |
| 3 |   Darwin  |
| 4 |   Hobart  |
| 5 |   Sydney  |
| 6 | Melbourne |
| 7 |   Perth   |

|   | City name |
|-: |---------: |
| 1 |  Adelaide |
| 2 |  Brisbane |
| 3 |    Darwin |
| 4 |    Hobart |
| 5 |    Sydney |
| 6 | Melbourne |
| 7 |     Perth |

| A | City name |
| :-| :---------|
| 1 | Adelaide  |
| 2 | Brisbane  |
| 3 | Darwin    |
| 4 | Hobart    |
| 5 | Sydney    |
| 6 | Melbourne |
| 7 | Perth     |

| A | City name |
| : | :-------: |
| 1 |  Adelaide |
| 2 |  Brisbane |
| 3 |   Darwin  |
| 4 |   Hobart  |
| 5 |   Sydney  |
| 6 | Melbourne |
| 7 |   Perth   |

| A | City name |
|-: |---------: |
| 1 |  Adelaide |
| 2 |  Brisbane |
| 3 |    Darwin |
| 4 |    Hobart |
| 5 |    Sydney |
| 6 | Melbourne |
| 7 |     Perth |

| AB | City name |
| :--| :---------|
| 1  | Adelaide  |
| 2  | Brisbane  |
| 3  | Darwin    |
| 4  | Hobart    |
| 5  | Sydney    |
| 6  | Melbourne |
| 7  | Perth     |

| AB | City name |
| :: | :-------: |
| 1  |  Adelaide |
| 2  |  Brisbane |
| 3  |   Darwin  |
| 4  |   Hobart  |
| 5  |   Sydney  |
| 6  | Melbourne |
| 7  |   Perth   |

| AB | City name |
|--: |---------: |
|  1 |  Adelaide |
|  2 |  Brisbane |
|  3 |    Darwin |
|  4 |    Hobart |
|  5 |    Sydney |
|  6 | Melbourne |
|  7 |     Perth |

| ABC | City name |
| :---| :---------|
| 1   | Adelaide  |
| 2   | Brisbane  |
| 3   | Darwin    |
| 4   | Hobart    |
| 5   | Sydney    |
| 6   | Melbourne |
| 7   | Perth     |

| ABC | City name |
| :-: | :-------: |
|  1  |  Adelaide |
|  2  |  Brisbane |
|  3  |   Darwin  |
|  4  |   Hobart  |
|  5  |   Sydney  |
|  6  | Melbourne |
|  7  |   Perth   |

| ABC | City name |
|---: |---------: |
|   1 |  Adelaide |
|   2 |  Brisbane |
|   3 |    Darwin |
|   4 |    Hobart |
|   5 |    Sydney |
|   6 | Melbourne |
|   7 |     Perth |
City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth

| | City name |
| : | :-------: |
| 1 | Adelaide |
| 2 | Brisbane |
| 3 | Darwin |
| 4 | Hobart |
| 5 | Sydney |
| 6 | Melbourne |
| 7 | Perth |

City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
A City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth

| A | City name |
| : | :-------: |
| 1 | Adelaide |
| 2 | Brisbane |
| 3 | Darwin |
| 4 | Hobart |
| 5 | Sydney |
| 6 | Melbourne |
| 7 | Perth |

A City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
AB City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth

| AB | City name |
| :: | :-------: |
| 1 | Adelaide |
| 2 | Brisbane |
| 3 | Darwin |
| 4 | Hobart |
| 5 | Sydney |
| 6 | Melbourne |
| 7 | Perth |

AB City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
ABC City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
ABC City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
ABC City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth

After

|   | City name |
| :-| :---------|
| 1 | Adelaide  |
| 2 | Brisbane  |
| 3 | Darwin    |
| 4 | Hobart    |
| 5 | Sydney    |
| 6 | Melbourne |
| 7 | Perth     |

|     | City name |
| :-: | :-------: |
|  1  |  Adelaide |
|  2  |  Brisbane |
|  3  |   Darwin  |
|  4  |   Hobart  |
|  5  |   Sydney  |
|  6  | Melbourne |
|  7  |   Perth   |

|   | City name |
|-: |---------: |
| 1 |  Adelaide |
| 2 |  Brisbane |
| 3 |    Darwin |
| 4 |    Hobart |
| 5 |    Sydney |
| 6 | Melbourne |
| 7 |     Perth |

| A | City name |
| :-| :---------|
| 1 | Adelaide  |
| 2 | Brisbane  |
| 3 | Darwin    |
| 4 | Hobart    |
| 5 | Sydney    |
| 6 | Melbourne |
| 7 | Perth     |

|  A  | City name |
| :-: | :-------: |
|  1  |  Adelaide |
|  2  |  Brisbane |
|  3  |   Darwin  |
|  4  |   Hobart  |
|  5  |   Sydney  |
|  6  | Melbourne |
|  7  |   Perth   |

| A | City name |
|-: |---------: |
| 1 |  Adelaide |
| 2 |  Brisbane |
| 3 |    Darwin |
| 4 |    Hobart |
| 5 |    Sydney |
| 6 | Melbourne |
| 7 |     Perth |

| AB | City name |
| :--| :---------|
| 1  | Adelaide  |
| 2  | Brisbane  |
| 3  | Darwin    |
| 4  | Hobart    |
| 5  | Sydney    |
| 6  | Melbourne |
| 7  | Perth     |

|  AB | City name |
| :-: | :-------: |
|  1  |  Adelaide |
|  2  |  Brisbane |
|  3  |   Darwin  |
|  4  |   Hobart  |
|  5  |   Sydney  |
|  6  | Melbourne |
|  7  |   Perth   |

| AB | City name |
|--: |---------: |
|  1 |  Adelaide |
|  2 |  Brisbane |
|  3 |    Darwin |
|  4 |    Hobart |
|  5 |    Sydney |
|  6 | Melbourne |
|  7 |     Perth |

| ABC | City name |
| :---| :---------|
| 1   | Adelaide  |
| 2   | Brisbane  |
| 3   | Darwin    |
| 4   | Hobart    |
| 5   | Sydney    |
| 6   | Melbourne |
| 7   | Perth     |

| ABC | City name |
| :-: | :-------: |
|  1  |  Adelaide |
|  2  |  Brisbane |
|  3  |   Darwin  |
|  4  |   Hobart  |
|  5  |   Sydney  |
|  6  | Melbourne |
|  7  |   Perth   |

| ABC | City name |
|---: |---------: |
|   1 |  Adelaide |
|   2 |  Brisbane |
|   3 |    Darwin |
|   4 |    Hobart |
|   5 |    Sydney |
|   6 | Melbourne |
|   7 |     Perth |
City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
A City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
A City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
A City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
AB City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
AB City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
AB City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
ABC City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
ABC City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth
ABC City name
1 Adelaide
2 Brisbane
3 Darwin
4 Hobart
5 Sydney
6 Melbourne
7 Perth

@hugovk hugovk added the changelog: Fixed For any bug fixes label Apr 2, 2024
Copy link

codecov bot commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.51%. Comparing base (1f156f8) to head (fd24cf6).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #296      +/-   ##
==========================================
+ Coverage   94.48%   94.51%   +0.02%     
==========================================
  Files           5        5              
  Lines        2431     2441      +10     
==========================================
+ Hits         2297     2307      +10     
  Misses        134      134              
Flag Coverage Δ
macos-latest 94.46% <100.00%> (+0.02%) ⬆️
ubuntu-latest 94.46% <100.00%> (+0.02%) ⬆️
windows-latest 94.42% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hugovk
Copy link
Member Author

hugovk commented Apr 3, 2024

Hi @mumblingMac!

This is a follow-on from #268, how does this fix look?

@hugovk hugovk merged commit 2702d6b into jazzband:main Apr 9, 2024
27 of 28 checks passed
@hugovk hugovk deleted the fix-narrow-markdown-columns branch April 9, 2024 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: Fixed For any bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown tables with narrow columns don't render
1 participant