C#: CS1591 from NoWarn to suggestion
#81934
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Repiteo
force-pushed
the
c#-CS1591-disabled-to-suggestion
branch
from
8666ad8
to
657d81e
Compare
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Migrates
CS1591(Missing XML comment for publicly visible type or member) fromGodotSharp.csprojto a custom rule in.editorconfig. Instead of being outright removed as a warning, it's now handled as a suggestion; this retains the benefit of cleaning up the flood editor warnings, but doesn't tuck away it completely (for the editor, it's functionally disabled for build-related tasks). The actual method it will choose to show a suggestion depends on the IDE, but it's never in a way that frustratingly pollutes the editor (or, at least, not anywhere close to the extent seen with warnings)I prefer this style over outright disabling it because, as the comment on the original implementation mentions, this is meant to be a temporary measure. Keeping it hidden away entirely doesn't give much incentive to eventually populate the documentation, and risks future contributions not realizing it was an expectation in the first place. I believe keeping it as a suggestion will lend itself to the gradual implementation of the remaining documentation