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

Improve the doc/intellisense for @info decorator #2228

Closed
mikekistler opened this issue Jul 31, 2023 · 1 comment · Fixed by #3280
Closed

Improve the doc/intellisense for @info decorator #2228

mikekistler opened this issue Jul 31, 2023 · 1 comment · Fixed by #3280
Assignees
@RodgeFu
Labels
ide Issues for VS, VSCode, Monaco, etc.
Milestone
Backlog

Comments

@mikekistler
Copy link
Member

The doc/intellisense for @info should be more helpful in guiding users on the content and format of its arguments. Currently the help just says:

Specify OpenAPI additional information. The service title and version are already specified using @service.

Pasted Graphic 1

More helpful would be something like the @server help that names each value and its contents.

Pasted Graphic

The difference here may be that @info takes a model as a parameter whereas @server takes discreet parameters -- so perhaps changing @info to take discreet parameters is the easiest fix. But if we want decorators that accept models to have good help/intellisense, we should figure out how to do that.
@markcowl
Copy link
Contributor

  • improve tooling to provide help for the underlying model in these scenarios (OpenAPI.AdditionalInfo)

@markcowl markcowl added this to the Backlog milestone Jul 31, 2023
@markcowl markcowl added MQ ide Issues for VS, VSCode, Monaco, etc. and removed needs-area labels Jul 31, 2023
@RodgeFu RodgeFu mentioned this issue May 6, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 17, 2024
@RodgeFu @timotheeguerin
improve completion and onhover in VSCode for decorator and extended m…
b7f6948 
…odel (#3280)

add following feature
1. support completion when user typing model expression as decorator
argument value
2. support completion for extended model
3. support showing decorator model argument prop information when
hovering on model expression as decorator argument value

closes #3130, closes #2228, closes #1956

---------

Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com>
@RodgeFu RodgeFu self-assigned this May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RodgeFu RodgeFu

Labels
ide Issues for VS, VSCode, Monaco, etc.
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

improve completion and onhover in VSCode for decorator and extended model RodgeFu/typespec
4 participants
@bterlson @markcowl @RodgeFu @mikekistler