Skip to content

Magic callouts don't support formatting #1164

Open
@leemthompo

Description

@leemthompo

Describe the bug

@shainaraskas pointed out that magic callouts for code blocks don't seem to support formatting, unlike their explicit counterparts.

For example:

      PUT my-index-000001
      {
        "settings": {
          "index":{
            "mode":"standard" # This index uses the `standard` index mode
          }
        }
      }

Will render the raw backticks.

Image

Expected behavior

Unless this is intended behavior (which we should document), one would expect formatting to be applied.

Steps to reproduce

  1. Write a code block with a magic callout that uses formatting like this:
POST /_query?format=txt
{
  "query": """
    FROM cooking_blog 
    | WHERE description:"fluffy pancakes"  # This has `formatting` and a [link](www.link.com)
    | LIMIT 1000 
  """
}
  1. Observe the unformatted output

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions