search

Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
111 stars 176 forks source link

APIView Diagnostics - add suppressed status #2898

Open tjprescott opened 2 years ago

tjprescott commented 2 years ago

On Python, we are moving toward making APIView diagnostics potentially build failing issues or issues that prevent approval. To facilitate that, I'm working on a mechanism to suppress APIView errors on a case-by-case basis via code syntax (a la pylint). However, in the APIView web tool, it would be very useful if the diagnostic object had a property that could be set.

The model already supports four levels of diagnostics: Default, Info, Warning, Error.

This could either be a boolean property or another status. Having a boolean property would retain the character of the diagnostic while maintaining that it is suppressed, whereas simply have a "Suppressed" status would lose the character of the original diagnostic. For those reasons, I would recommend a boolean.

Suppressions would be handled in code, so there would be no web-side work except how they are displayed and supporting the new property in the model.

A suppressed diagnostic would still display in the UI, but it would be muted or changed visually so reviewers would know that this is suppressed.

tjprescott commented 2 years ago

cc @johanste @iscai-msft @annatisch @lmazuel @praveenkuttappan