Skip to content

Enable nullable: System.Management.Automation.Provider.ICmdletProviderSupportsHelp - #14150

Merged
Ilya (iSazonov) merged 2 commits into
PowerShell:masterfrom
powercode:nullable/ICmdletProviderSupportsHelp
May 18, 2021
Merged

Enable nullable: System.Management.Automation.Provider.ICmdletProviderSupportsHelp#14150
Ilya (iSazonov) merged 2 commits into
PowerShell:masterfrom
powercode:nullable/ICmdletProviderSupportsHelp

Conversation

@powercode

Copy link
Copy Markdown
Collaborator

Tracking issue: #12631.

@powercode
Staffan Gustafsson (powercode) force-pushed the nullable/ICmdletProviderSupportsHelp branch from 2d1b3c2 to 74ee1c5 Compare November 19, 2020 21:33
@ghost ghost added the Review - Needed The PR is being reviewed label Nov 28, 2020
@ghost

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

/// This interface needs to be implemented by providers that want users to see
/// provider-specific help.
/// </summary>
#nullable enable

Copy link
Copy Markdown

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);

Copy link
Copy Markdown

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.

@SteveL-MSFT Steve Lee (SteveL-MSFT) added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Dec 15, 2020
@iSazonov

Copy link
Copy Markdown
Collaborator

/azp run PowerShell-CI-static-analysis

@ghost ghost removed the Review - Needed The PR is being reviewed label May 18, 2021
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@iSazonov
Ilya (iSazonov) merged commit 94aa68d into PowerShell:master May 18, 2021
@iSazonov Ilya (iSazonov) added this to the 7.2.0-preview.6 milestone May 18, 2021
@powercode
Staffan Gustafsson (powercode) deleted the nullable/ICmdletProviderSupportsHelp branch May 25, 2021 21:26
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants