GoogleChrome / GoogleChrome/chrome-types

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

Open
#46 2 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
274
Forks
44
PR merge metrics
No merged PRs in 30d

Description

Check out [bluetoothSocket.CreateInfo](https://developer.chrome.com/docs/extensions/reference/bluetoothSocket/#type-CreateInfo), which is generated from [this file](https://source.chromium.org/chromium/chromium/src/+/main:extensions/common/api/bluetooth_socket.idl;l=33;drc=60039d4d4bd70512e21a2dfe586602aca1d9d35e). 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 $(ref:sockets.tcp) API.
```

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

![bad_doc_styling](https://user-images.githubusercontent.com/1915693/218556118-a59262d7-35ea-4b7f-8b06-1fa025077e3c.png)

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.