Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

False positive "Block and modifier ..." in code blocks

See original GitHub issue

Search terms

at-sign, block and modifier tags

Expected Behavior

README.md:

Some text @abc

    Code block @xyz

Should show “Block and modifier tags will be ignored within the readme” error for “abc” only.

Actual Behavior

Shows “Block and modifier tags will be ignored within the readme” error for “abc” and “xyz”.

The problem is that @ symbol can’t be escaped inside code block (https://www.markdownguide.org/basic-syntax/#code-blocks-1). If you replace @ with \@ in code block it will just show both characters.

Steps to reproduce the bug

README.md:

Some text @abc

    Code block @xyz

Issue Analytics

State:
Created a year ago
Comments:10 (5 by maintainers)

Top GitHub Comments

1reaction

Gerrit0commented, Jul 9, 2022

See, now there’s a reason that I hadn’t seen before - at the very least, TypeDoc should not create a tag if the lookahead when reading is - or /. (I think actually it should not unless there’s whitespace/eof)

I’ll go ahead and make this change, will be curious if that takes care of most of your warnings, or reveals another common case.

1reaction

Gerrit0commented, Jul 9, 2022

Nope, that’s not supported.

TypeDoc doesn’t grab everything after a @ as a tag. me@example.com will not be picked up as a tag