-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Enable nullable: System.Management.Automation.Provider.ICmdletProviderSupportsHelp #14150
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
Enable nullable: System.Management.Automation.Provider.ICmdletProviderSupportsHelp #14150
Conversation
a1ba215
to
2d1b3c2
Compare
2d1b3c2
to
74ee1c5
Compare
This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days. |
/// <summary> | ||
/// This interface needs to be implemented by providers that want users to see | ||
/// provider-specific help. | ||
/// </summary> | ||
#nullable enable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💭 This seems a bit strange. I would expect to see it before the documentation comment.
@@ -37,7 +39,7 @@ public interface ICmdletProviderSupportsHelp | |||
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Maml", Justification = "Maml is an acronym.")] | |||
string GetHelpMaml(string helpItemName, string path); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation for this method does not specify what a null
return value means. I would expect the implementations and callers of this interface to be annotated at the same time as this interface to ensure the pre- and post-conditions are correctly captured.
/azp run PowerShell-CI-static-analysis |
Azure Pipelines successfully started running 1 pipeline(s). |
Tracking issue: #12631.