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.

Sign up for GitHub

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

Jump to bottom

dev doc comments does not consistently set @doc for Azure libs #1994

Closed
allenjzhang opened this issue Jun 1, 2023 · 4 comments · Fixed by #2096
Closed

dev doc comments does not consistently set @doc for Azure libs #1994

allenjzhang opened this issue Jun 1, 2023 · 4 comments · Fixed by #2096
Assignees
@timotheeguerin
Labels
bug Something isn't working
Milestone
[2023] July

Comments

@allenjzhang
Copy link
Member

It seems dev doc comments are not setting @doc consistently for Azure libraries. Not reproing on OSS playground. Not sure if it is emitter specific issue.

Playground link

  • Line 20 On namespace
  • Line 23 on Employee Tracked resource
@timotheeguerin
Copy link
Member

timotheeguerin commented Jun 1, 2023 •
edited
Loading

First one seems like a bug, second one I think is related to #1946 and the fact that @doc takes priority. We probably need to decide what is the logic here. I agree that it make sense that it would work here but I think need to make sure we can find a logic that make sense on when the doc comment is taken vs when @doc is

@markcowl
Copy link
Contributor

markcowl commented Jun 5, 2023

related to #1946 in the second case (overriding an @doc from an is)

@markcowl markcowl added the bug Something isn't working label Jun 5, 2023
@markcowl markcowl added this to the [2023] July milestone Jun 5, 2023
@markcowl
Copy link
Contributor

markcowl commented Jun 6, 2023

Use this issue to fix the issue with namespaces

@markcowl markcowl added 📌 and removed Needs Triage labels Jun 6, 2023
@timotheeguerin timotheeguerin self-assigned this Jun 20, 2023
@timotheeguerin
Copy link
Member

So this is actually a problem because the doc comment is in between the decorators and the namespace

@timotheeguerin timotheeguerin mentioned this issue Jun 20, 2023
Merged
@timotheeguerin timotheeguerin mentioned this issue Jun 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@timotheeguerin timotheeguerin

Labels
bug Something isn't working
Projects
None yet
Milestone
[2023] July
Development

Successfully merging a pull request may close this issue.

Fix annotation order timotheeguerin/typespec
3 participants
@timotheeguerin @markcowl @allenjzhang