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

QoL fix: generated comments #1031

Open
richardpark-msft opened this issue Sep 14, 2023 · 0 comments
Open

QoL fix: generated comments #1031

richardpark-msft opened this issue Sep 14, 2023 · 0 comments
Labels
CodeGen Issues that relate to code generation Docs feature-request This issue requires a new behavior in the product in order be resolved. MQ This issue is part of a "milestone of quality" initiative.

Comments

@richardpark-msft
Copy link
Member

pkg.go.dev does a good job of providing links if you use the [] syntax for enclosing them in a doc comment. We can take advantage of this more in our generator by enclosing the method in brackets like this "this options type is for [blah method]"
@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Sep 14, 2023
@RickWinter RickWinter transferred this issue from Azure/azure-sdk-for-go Sep 18, 2023
@RickWinter RickWinter added feature-request This issue requires a new behavior in the product in order be resolved. CodeGen Issues that relate to code generation MQ This issue is part of a "milestone of quality" initiative. Client This issue points to a problem in the data-plane of the library. labels Sep 18, 2023
@jhendrixMSFT jhendrixMSFT added Docs and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. Client This issue points to a problem in the data-plane of the library. labels Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CodeGen Issues that relate to code generation Docs feature-request This issue requires a new behavior in the product in order be resolved. MQ This issue is part of a "milestone of quality" initiative.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@RickWinter @jhendrixMSFT @richardpark-msft