Skip to content

Julia component generator should escape $ within docstrings #1269

Description

@rpkyle

Following my attempt to build DashTable.jl, the following error appeared:

[ Info: Precompiling DashTable [1b08a953-4be3-4667-9a23-759fc69216d1]
ERROR: LoadError: LoadError: syntax: invalid interpolation syntax: "$'"

The culprit appears to be two occurrences of $' within the docstring, based on my reading of this issue: JuliaLang/julia#10816.

We should modify the component generator to prepend a \ to escape $ whenever they occur, which should resolve the error at component build time in the future.

A similar change was made for the R component generator, to address unescaped backslashes:

# auto-replace any unescaped backslashes for compatibility with R docs
description = re.sub(r"(?<!\\)%", "\\%", description)
item_text = re.sub(r"(?<!\\)%", "\\%", item_text)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions