Skip to content

Question: unexpected markdown docstring #2661

@yinhua2023

Description

@yinhua2023

We're using typespec to define our API and we noticed that if we add multi-line comment with below format:
e.g.

/** this is a firstline of docstring
 * the second line of docstring
 * the third line of docstring
 * /
model MyModel{
    x: string;
}

The generated RLC code will have an unexcepted markdown as below:
role:: raw-html-m2r(raw)
:format: html

If I change the comment as below format(first line should be empty), then the markdown will disappear.

/**
 * this is a firstline of docstring
 * the second line of docstring
 * the third line of docstring
 * /
model MyModel{
    x: string;
}

Is this expected behavior and how can I avoid to have these markdown with the first format in the docstring of python RLC code?
And I found this issue is not happened for typescript language generation.

Thank you.

Metadata

Metadata

Assignees

No one assigned

    Labels

    customer-reportedIssues that are reported by GitHub users external to the Azure organization.questionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions