Use \ for escaping in markdown

[ankon]

The HTML entities didn't "work", and the documentation contained them literally on the main site.

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• tests and/or benchmarks are included
• documentation is changed or added
• commit message follows commit guidelines

[aduh95]

Refs: https://nodejs.org/docs/latest-v10.x/api/inspector.html#inspector_event_lt_inspector_protocol_method_gt

[Trott]

Hi, @ankon! Welcome, and thanks for the pull request! This would seem to be a bug in the markdown processing we use as HTML entities should be rendered in this situation.

@rubys @vsemozhetbyt Bug in the new HTML generation stuff that needs to be fixed?

@nodejs/documentation are angle brackets (< >) even the right thing to use in this situation? I'm having a hard time coming up with a better and more intuitive way to express that this is not a literal value, so maybe it is?

[vsemozhetbyt]

Thank you for the spotting and an attempt to fix. However, this is a part of a bigger issue that should be fixed in #22140 (probably after one more fix upstream, see comments there).

[rubys]

I agree with @vsemozhetbyt - the markup is correct, the processing of the markup is what is in error.

[Trott]

@rubys @vsemozhetbyt How long do we estimate before a fix appears? Is it worth it to do something like this as a temporary measure until the larger fix lands? (My sense is "no" if the larger fix is a few days away, but "perhaps" if it's longer than that.)

[rubys]

@Trott it should be days. I know what needs to be fixed and will submit the necessary pull requests. I seem to have gotten the attention of the maintainer who will land pull requests and push out new modules in a matter of minutes. The issue here is that Remark is a set of small modules, and this last change will affect at least two of them, as well as the data structure that is passed between them (MDAST).

Meanwhile, my preferred quick fix is here: c9e7083

And the accumulated set of workarounds to date can be found here: #22084

If there is a pressing need, I'm willing to land #22084 while we wait for #22140 (the latter both undoes #22084 as well as prior quick fixes, and depends on Remark.js doing the right thing™).

[ankon]

Thanks for looking at this, from my point: If you're working on a fix, do that -- the intent of the documentation is clear enough, this is just a cosmetical PR :)

[addaleax]

ping @rubys – anything (left) to do here?

[rubys]

Closing this pull request as the problem was fixed another way: see https://nodejs.org/download/nightly/v11.0.0-nightly2018090259e5a39d30/docs/api/inspector.html#inspector_event_lt_inspector_protocol_method_gt

Thanks @ankon!