chrome-types icon indicating copy to clipboard operation
chrome-types copied to clipboard

Wrapping a `$(ref:...)` in <code></code> outputs broken links and style

Open rdcronin opened this issue 2 years ago • 2 comments

Check out bluetoothSocket.CreateInfo, which is generated from this file. The description in the file is:

    // The ID of the newly created socket. Note that socket IDs created
    // from this API are not compatible with socket IDs created from other APIs,
    // such as the <code>$(ref:sockets.tcp)</code> API.

Wrapping the $(ref:sockets.tcp) in <code> tags results in broken output in the server.

bad_doc_styling

We should either a) remove all instances of tags wrapping $(refs) and add a warning or b) have the output handle it appropriately.

rdcronin avatar Feb 13 '23 19:02 rdcronin

@rdcronin Thanks for letting us know.

jpmedley avatar Feb 13 '23 19:02 jpmedley

I'm reviving this. For reasons related to a years worth of cleanup and more that's coming, this could start to stand out soon.

jpmedley avatar Aug 21 '23 14:08 jpmedley