Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: getDoc mishandled the description if it has a line of description ends with "\" #3646

Closed
4 tasks done
qiaozha opened this issue Jun 24, 2024 · 0 comments · Fixed by #3881
Closed
4 tasks done
Assignees
Labels
bug Something isn't working compiler:core Issues for @typespec/compiler triaged:core
Milestone

Comments

@qiaozha
Copy link
Member

qiaozha commented Jun 24, 2024

Describe the bug

model Foo {
  /**
   * The embedding vector, which is a list of floats. The length of vector depends on the model as\
   * listed in the [embedding guide](/docs/guides/embeddings).
   */
  embedding: float64[];
}

the getDoc result we have in compiler version v0.56.0 is
image
But it has an additional * in the compiler version 0.57.0 result
image

I feel like the openapi3 emitter result is also incorrect

Reproduction

playground link

Checklist

@qiaozha qiaozha added the bug Something isn't working label Jun 24, 2024
@markcowl markcowl added this to the [2024] July milestone Jun 24, 2024
@markcowl markcowl added triaged:core compiler:core Issues for @typespec/compiler labels Jun 24, 2024
@markcowl markcowl modified the milestones: [2024] July, [2024] August Jul 15, 2024
@chrisradek chrisradek self-assigned this Jul 16, 2024
github-merge-queue bot pushed a commit that referenced this issue Jul 18, 2024
… comment line (#3881)

Fixes #3646

Updated `scanDoc` to only update the escaped flag when a backslash
precedes `@`. This is the only character we currently unescape later on
in this scenario currently.

Co-authored-by: Christopher Radek <Christopher.Radek@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working compiler:core Issues for @typespec/compiler triaged:core
Projects
None yet
3 participants