Azure / autorest.python

Extension for AutoRest (https://github.com/Azure/autorest) that generates Python code
MIT License
76 stars 54 forks source link

Question: unexpected markdown docstring in RLC code #2661

Open yinhua2023 opened 6 days ago

yinhua2023 commented 6 days ago

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.