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.

LDoc is incorrectly parsed

See original GitHub issue


name version
IDEA version 2019.2.2
EmmyLua version
OS Arch Linux

If we are speaking about the same LDoc, then current implementation in this plugin is wrong. It marks comments as docs only if all lines are started with --- although only the first one should start with that.

This is ok:


However this does not work, although it should (in LDoc manual scroll to nearest multiline example):


<kbd>ctrl+q</kbd> also shows no documentation for the latter case. A big example would be awesome wm.

Also, when you press <kbd>Backspace</kbd> after --- it removes all three characters. I guess this is intentional, but please at least add a config option to disable that

Issue Analytics

  • State:open
  • Created 4 years ago
  • Comments:9 (2 by maintainers)

github_iconTop GitHub Comments

necauquacommented, Oct 20, 2019

Aha, understood But LDoc is still widely used and if you use a well-documented library that uses LDoc then you cant see all that documentation. I mean that even partially supporting LDoc should be easy, just allow --- only to be the first line of the doc comment, LDoc also has annotations and most of them work the same way afaiu.

redcatbearcommented, Mar 23, 2022

I agree that standard LDoc support would be a valuable improvement, especially because existing linters and documentation renderers all expect LDoc.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Explicit HTML is incorrectly parsed by JSoup - Stack Overflow
I'm using JSoup for parsing HTML. It generally works OK, but in some explicit example it changes element sequence in HTML after parsing....
Read more >
Parsing arguments and building values — Python 3.11.1 ...
This function returns true on success and false if args is not a tuple or contains the wrong number of elements; an exception...
Read more >
Unparsable structured data report - Search Console Help
This report lists structured data found on your site that could not be parsed because of a serious syntax error. The intended type...
Read more >
Event data processing in QRadar - IBM
In IBM QRadar, use the DSM Editor to solve parsing problems and to add custom ... performance by avoiding the creation of incorrectly...
Read more >
Passing ODI Variables as Parameters Results in Incorrect ...
Passing ODI Variables as Parameters Results in Incorrect Substitution by the Parsing Phases. (Doc ID 423901.1). Last updated on OCTOBER 04, ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found