New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
False positive "Block and modifier ..." in code blocks #1990
Comments
If you use |
@Gerrit0 I got the same problem and I don't think it has to do with the block comment in the code, this is the |
Yes, readme files are parsed with
I ended up going with option 1, because while today readme files aren't allowed to use block/modifier tags, I could foresee a use case where this might no longer be the case with the upcoming guides work, and it's easier to be more restrictive initially and relax those restrictions later. |
@Gerrit0 hm, sorry I'm quite new to For example, can I specify somewhere so that |
Nope, that's not supported. TypeDoc doesn't grab everything after a |
Does it make sense to be a feature in your vision for the project?
I meant token starting with |
I don't think it does. This could be that I don't understand why you're asking... Are false positives in readmes more common than I think? Maybe there's a good argument that I haven't heard yet for why I should have gone with option 2 in my previous post. |
Yeah, I think I'm obviously biassed since I'm trying to pledge my case, but for me, in particular, it's But then again, even when such an option exists, what if we have a package name I think maybe we can step back and just treat |
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 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. |
@Gerrit0 Yes, as always, thank you for your care and quick turnaround! |
Search terms
at-sign, block and modifier tags
Expected Behavior
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
The text was updated successfully, but these errors were encountered: