Closed Bug 1654880 Opened 6 years ago Closed 6 years ago

Generated tables aren't valid markdown

Categories

(Data Platform and Tools :: Glean: SDK, defect, P1)

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: mhentges, Assigned: janerik)

Details

Attachments

(1 file)

It looks like a new header was added to the output'd markdown table (Data Sensitivity), but the "header designation line" is missing a column.

For example, in my generated markdown, I'm seeing:

| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefix/Data_Collection) |
| --- | --- | --- | --- | --- | --- |
| foo.bar |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |description |[1](data review)||never | |

There's 7 columns, but only six | --- |

To reproduce:

  1. Create a file called metrics.yaml:
foo:
  bar:
    type: string
    description: "description"
    bugs:
      - "bug"
    data_reviews:
      - "data review"
    expires: never
    notification_emails:
      - mhentges@mozilla.com
  1. glean_parser translate -f markdown -o . metrics.yaml
  2. View the rendered markdown

Expected output

| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefix/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| foo.bar |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |description |[1](data review)||never | |

(Note the second line)

Attached file GitHub Pull Request
Assignee: nobody → jrediger
Priority: -- → P1
Status: NEW → RESOLVED
Closed: 6 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: