⚠️ Boost visibility of raw data argument documentation warnings#677
Open
nevans wants to merge 1 commit into
Open
⚠️ Boost visibility of raw data argument documentation warnings#677nevans wants to merge 1 commit into
nevans wants to merge 1 commit into
Conversation
These methods share some of their argument handling, and this was documented by referencing the method they behaved like. Nevertheless, this warning can easily be missed, and it's important enough to call it out explicitly in every method where it's applicable.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
These methods share some of their argument handling. And, in every case, this was already documented by referencing the method they behaved like. Nevertheless, this warning can easily be missed, and it's important enough to call it out explicitly in every method where it's applicable.