Skip to content

Broken markdown table when empty lines are present in field description #52

Closed

Description

Problem description

When a field has an empty line in the description, e.g.

// IngressClass enables support for the older Ingress resource and indicates
// which Ingress resources this Gateway should be responsible for.
//
// If omitted, Ingress resources will not be supported by the ControlPlane.
//
// +optional
IngressClass *string `json:"ingressClass,omitempty"`

This produces incorrect tables in markdown

| `ingressClass` _string_ | IngressClass enables support for the older Ingress resource and indicates which Ingress resources this Gateway should be responsible for. 
 If omitted, Ingress resources will not be supported by the ControlPlane. |

which render in the following way:

image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions