question-mark
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.

/*~err~*/ comments for code-snippet error underlying feature missing since CODEDOC 0.2.15

See original GitHub issue

The Error/Warning Underline feature (requested in issue #49 and documentation here) was added in codedoc/core 0.2.9. Support was later added for block comments (* *) (requested in issue #71) in codedoc/core 0.2.15.

Unfortunately, codedoc/core 0.2.15 also removed support for /* */ comments. I determined this by testing before and after this commit in which I only upgraded from 0.2.14 to 0.2.15 and checking the locally hosted version of this line on my live site. The regression still exists in the latest version, which is 0.2.19.

Since the documentation for the Error/Warning Underline feature shows working examples using /* */ comments, this tells me that the site was deployed using 0.2.14 or earlier. At the same time, the source code for the CODEDOC docs has codedoc/core at version 0.2.19. This makes me want there to be an easy way to know which version of dependencies like codedoc/core and codedoc/coding-blog-plugin were used when creating a CODEDOC site. To that end, here is a (crazy?) idea. What if every CODEDOC site included a page at (say) urlBeginning/codedoc_dependencies that shows the contents of the dependencies section of the package.json file. Here is that section for CODEDOC docs and my blog.

More practically, can the the documentation for the Error/Warning Underline feature be improved by adding an example that uses (* *)? Then the examples would include uses of both /* */ and (* *), and I could point out the regression to /* */ there instead of having to use my blog.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
loreanvictorcommented, Dec 16, 2020

it was a typo really, I think /*~err*/ would have worked 😅😅

1reaction
loreanvictorcommented, Dec 16, 2020

deployed via @codedoc/core@0.2.20

Read more comments on GitHub >

github_iconTop Results From Across the Web

No results found

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 Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found