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.

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

Consider Removing Support for [[suppress-warning:invalid-metadata]] #3202

Open
InsertCreativityHere opened this issue Nov 26, 2024 · 0 comments

Comments

@InsertCreativityHere
Copy link
Member

Currently There are 3 categories of warnings that can be suppressed:
Deprecated, InvalidMetadata, and InvalidComment.

There's an obvious use case for suppressing deprecation warnings (you're using an old API and can't update to the new one yet).
I also think there's a case for suppressing comment warnings (you're using doxygen tags that the Slice compiler isn't aware of, but that are still valid).

But there isn't a good case for ignoring bad metadata, especially now that the metadata validation is accurate and robust.
I think that issuing warnings is correct, we shouldn't halt compilation and fail to build over metadata issues.
But these also are not the kinds of things you should just ignore and leave unfixed.

Therefore, I propose dropping support for suppressing InvalidMetadata warnings.


Note that suppress warnings also has support for an All argument, which of course ignores all warnings.
I think that this behavior should be preserved. So if you suppress All, this would still include InvalidMetadata warnings,
despite there being no other way to do suppress invalid metadata.

This is reasonable because if a user is suppressing all warnings, they're clearly doing something strange, and do not want the Slice compiler bothering them about anything. And it would be very strange to see the compiler issuing warnings after you told it to suppress all of them.

Note that we already have some "misc" warnings that can only be ignoring by the All option.
For example, ice2slice issues warnings for consts (since there's no way to map them into new Slice), and there is no category of warnings you can use to ignore these warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant