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

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

Closed
pmalek opened this issue Sep 20, 2023 · 0 comments · Fixed by #53
Closed

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

pmalek opened this issue Sep 20, 2023 · 0 comments · Fixed by #53

Comments

@pmalek
Copy link

pmalek commented Sep 20, 2023

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
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant