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.

Examples in @doc tags are no longer being rendered

See original GitHub issue

Environment

  • Elixir & Erlang versions (elixir --version): Erlang/OTP 24 [erts-12.2.1] [source] [64-bit] [smp:4:4] [ds:4:4:10] [async-threads:1] [jit:no-native-stack] Elixir 1.13.2 (compiled with Erlang/OTP 24)
  • VSCode ElixirLS version: 0.9.0
  • Operating System Version: linux 5.13.0-22-generic

Troubleshooting

  • Restart your editor (which will restart ElixirLS) sometimes fixes issues
  • Stop your editor, remove the entire .elixir_ls directory, then restart your editor

Description

Since a few weeks ago (possibly after Elixir and Phoenix updates to latest versions), the context tooltip no longer renders ANY iex> lines from within moduledocs. Yes, not even the stdlib!

If I were to un-tab the iex> lines, they begin to be treated as normal text, and are shown.

I have tested this on multiple projects, including a new mix project. All running inside the latest elixir Docker.

For reference, here is a textual copypaste of the docblock, in case I’ve made a typo:

  @doc """
  Marko `test`

  ## Example:

      iex> AggregateDataParser.parse_csv_file(nil)
      :ok

  ## Test2:
  Marko *test*.

  """
  def parse_csv_file(filename), do: filename |> File.stream!() |> parse_csv_stream
Screenshot 2022-02-14 at 13 02 32 Screenshot 2022-02-14 at 13 02 43

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:1
  • Comments:17

github_iconTop GitHub Comments

2reactions
henrythebuildercommented, Feb 28, 2022

Hi, It seems to be a problem (in vscode) only for ‘four spaces indented’ code blocks. I tried to write a comment to a ‘js’ function and I had the same problem:

/**
 *> hello()
 *
 *Hello world.
 *
 *## Example ('four spaces indented' code block)
 *
 *    iex> Ex.hello()
 *         :world
 *
 *## Example ('fenced' code block)
 *
 *```
 *    iex> Ex.hello()
 *         :world
 *```
**/
function hello() {
  console.log("Hello World!");
}

vscode-hover-help

Visual Studio Code seems to render only the ‘fenced’ code block. Could you confirm this too?

1reaction
lovebescommented, Mar 4, 2022

awesome same for me too!! Although … didn’t it used to have a different background color? To note it’s a code block? Maybe I’m imagining things. Anyhow I’m just happy I got them back 😃

Read more comments on GitHub >

github_iconTop Results From Across the Web

Noscript tags no longer rendering components in 16.5.0 #15238
Noscript tags no longer rendering components in 16.5.0 #15238 ... are being rendered, and in the second example they're not being rendered.
Read more >
Java: Javadoc tags | I'd Rather Be Writing Blog
Java: Javadoc tags ; @deprecated, Lets users know the class or method is no longer used. This tag will be positioned in a...
Read more >
How to Write Doc Comments for the Javadoc Tool - Oracle
This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, ...
Read more >
HTML elements reference - HTML: HyperText Markup Language
The <s> HTML element renders text with a strikethrough, or a line through it. Use the <s> element to represent things that are...
Read more >
GPT request modes and asynchronous rendering
Google Publisher Tags offer flexibility in how you request ads from Ad Manager, and you'll then render ... Developers can view example tags...
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 Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found