This PR attempts to fix a rendering issue with the docs for uiSrefActive. Due to TypeDoc not automatically escaping HTML tags, the unescaped <div> and <a> HTML tags in the docstring break the rendering. I've attempted to fix this by surrounding them with backquotes, which will hopefully render them as code per Markdown standards.
Note that I don't have any way to preview this change so I'm just hoping it works. Maybe someone familiar with TypeDoc can verify.
I am not sure if there are any other instances of this issue in the docs, this is just the one I noticed.
christopherthielen
commented
6 years ago
This PR attempts to fix a rendering issue with the docs for
uiSrefActive. Due to TypeDoc not automatically escaping HTML tags, the unescaped<div>and<a>HTML tags in the docstring break the rendering. I've attempted to fix this by surrounding them with backquotes, which will hopefully render them as code per Markdown standards.Note that I don't have any way to preview this change so I'm just hoping it works. Maybe someone familiar with TypeDoc can verify.
I am not sure if there are any other instances of this issue in the docs, this is just the one I noticed.