Skip to content

API docs generator: HTML special characters are getting escaped too many times #56578

Description

@kontaras

This is a Bug Report

Problem:

When autogenerating HTML API documentation like https://kubernetes.io/docs/reference/kubernetes-api/definitions/quantity-resource/ , the generator is encoding HTML special characters twice (for example, changing < to &lt; and then escaping it again as &amp;lt;).

If you look at the source code comments, it says:
(Note that <suffix> may be empty, from the "" case in <decimalSI>.)
but looking at the kubernetes site in a browser, it is rendered as:
(Note that &lt;suffix&gt; may be empty, from the &#34;&#34; case in &lt;decimalSI&gt;.)

Proposed Solution:

Page to Update:
https://kubernetes.io/docs/reference/kubernetes-api/definitions/quantity-resource/

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/bugCategorizes issue or PR as related to a bug.needs-triageIndicates an issue or PR lacks a `triage/foo` label and requires one.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions