Files
DefinitelyTyped/types
Leonard Thieu abbce5d159 [jquery] Documentation improvements (#29658)
* [jquery] Fix code for example not rendering in VS Code autocomplete.

VS Code does not render the code block of the last example in the autocomplete tooltip (but does in the hover tooltip). This is fixed by adding an additional line terminated by a zero-width space. There doesn't appear to be an obvious pattern to what causes this and there may be other incidences of this bug in the declarations.

* [jquery] Improve formatting of documentation for unified signatures in tooltips.

Documentation for unified signatures is also unified. This means that documentation for a parameter will contain documentation from all the parameters that it's composed of. VS Code and WebStorm render this as one continuous line. This makes it confusing as it's not obvious which parts of documentation apply to a parameter.

To remedy this, parameters are formatted as a bulletted list. `<br>` tags are necessary to force line breaks in WebStorm. The list also cannot start on the first line. To force the first line break, the `<br>` tag is used for WebStorm. For VS Code, a non-empty body must follow the parameter name on its line. A Braille Pattern Blank could be used here but to provide a more intuitive and consistent experience, VS Code's format for rendering parameter info is mimicked instead. The `@` symbol must be encoded to prevent `@param` from being parsed as a JSDoc tag.

Note: VS Code renders the `<br>` tags literally and there does not appear to be a way to hide them.
2018-10-11 11:45:40 -07:00
..
2018-10-03 11:47:28 -07:00
2018-10-03 11:47:28 -07:00
2018-10-03 11:47:28 -07:00
2018-10-01 21:03:52 -07:00
2018-10-01 20:51:05 -07:00
2018-10-03 11:47:28 -07:00
2018-10-04 10:56:42 -07:00
2018-10-04 10:54:05 -07:00
2018-09-28 18:24:51 +03:00
2018-10-09 12:06:30 -07:00
2018-10-04 10:00:54 +05:30
2018-10-09 14:05:09 -07:00
2018-10-01 08:12:20 -07:00
2018-10-10 18:56:22 -07:00
2018-10-03 11:49:37 -07:00
2018-10-10 09:27:15 -07:00
2018-10-10 09:07:26 -07:00
2018-10-04 12:06:39 -07:00
2018-10-03 11:47:28 -07:00
2018-10-03 11:56:52 -07:00
2018-10-01 14:38:08 -07:00
2018-10-05 12:10:16 +01:00
2018-10-01 10:57:00 -07:00
2018-10-10 14:17:45 -07:00
2018-10-10 09:19:02 -07:00
2018-10-09 21:26:01 -07:00
2018-10-01 21:31:48 -07:00
2018-10-09 12:09:03 -07:00
2018-10-09 21:27:02 -07:00
2018-10-10 16:56:48 -07:00
2018-10-09 08:44:21 -07:00