mdsmith
Esc
    v0.52.0 GitHub
    MDS026 table ready

    MDS026: table-readability

    Tables must stay within readability complexity limits.

    This rule is separate from MDS023 and MDS024. Table complexity needs table-specific metrics.

    # Settings

    SettingTypeDefaultDescription
    max-columnsint8Maximum columns per table
    max-rowsint30Maximum data rows per table
    max-words-per-cellint30Maximum words allowed in a single cell
    max-column-width-ratiofloat60.0Maximum ratio between widest and narrowest average column widths

    # Config

    rules:
      table-readability:
        max-columns: 8
        max-rows: 30
        max-words-per-cell: 30
        max-column-width-ratio: 60.0

    Disable:

    rules:
      table-readability: false

    # Examples

    # Good

    # Readable Table
    
    | Metric     | Value  |
    | ---------- | ------ |
    | Latency    | <200ms |
    | Error rate | <1%    |

    # Bad

    # Hard to Scan
    
    | A | B | C | D |
    |---|---|---|---|
    | 1 | 2 | 3 | 4 |

    # Diagnostics

    • table has too many columns (N > limit)
    • table has too many rows (N > limit)
    • table cell has too many words (N > limit)
    • table has high column width ratio (ratio > limit)

    # Edge Cases

    • Tables inside fenced code blocks are skipped.
    • Blockquote and indented tables are checked.

    # Meta-Information

    • ID: MDS026
    • Name: table-readability
    • Status: ready
    • Default: enabled
      • max-columns: 8
      • max-rows: 30
      • max-words-per-cell: 30
      • max-column-width-ratio: 60.0
    • Fixable: no
    • Implementation: source
    • Category: table