Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Re-enable warnings which are currently disabled in the build

See original GitHub issue

Currently there are some warnings disabled in the build (mostly related to /// comments). #2258 removes some of them, but even after that is merged there will be these remaining: <NoWarn>1591;1573</NoWarn>. Note that these warnings are disabled in this file.

1591 is about missing comments 1573 is about missing <param> tags in comments.

It seems that AutoRest should generate code which is C# compliant (with no warnings), and that we should have these flags turned on in this repo to ensure that we ship the best possible documentation to our clients.

Cost: 3

Issue Analytics

State:
Created 7 years ago
Comments:7 (7 by maintainers)

Top GitHub Comments

1reaction

matthchrcommented, Aug 16, 2018

Shouldn’t we have 1591 enabled on our actual SDKs? (I don’t really care about tests, just SDKs).

And if the code-generator isn’t generating code with comments, fix the generator so it does?

It seems a pretty reasonable requirement that all public methods have comments in the public SDKs, right?

0reactions

erich-wangcommented, Aug 23, 2019

@kurtzeborn, if the warnings come from generated code, there’s little thing we team could do since current process need service team to generate code. Please feel free to reopen the issue.

Top Results From Across the Web

How can I disable a C/C++ `-Werror` build error in Bazel? ...

The answer is to use the -Wno-error=<name> build flag, as described ... Learn to enable/disable GCC and Clang compiler warnings and options ...

Buildifier warnings - bazelbuild/buildtools

The native module shouldn't be used in BUILD files. Category name: native-build; Automatic fix: yes; Suppress the warning: # buildifier: disable=native-build.

Disable warnings during build - support

I have tried list.json in layouts/_default but it is not working. Here is the warning. found no layout file for "JSON" for ...

C# Compiler Options to report errors and warnings

C# Compiler Options for errors and warnings. These options suppress or enable warnings, and control warnings as errors.

Why should one want to disable compiler warnings?

There are quite a few reasons to selectively disable compiler warnings, ... the "treat warnings as errors" directive on the build server.