Skip to content

Style: Add period before returns doc tag#8535

Merged
iSazonov merged 7 commits intoPowerShell:masterfrom
iSazonov:style-docs-period-returns
Dec 25, 2018
Merged

Style: Add period before returns doc tag#8535
iSazonov merged 7 commits intoPowerShell:masterfrom
iSazonov:style-docs-period-returns

Conversation

@iSazonov
Copy link
Collaborator

@iSazonov iSazonov commented Dec 24, 2018

PR Summary

Style fix:

  • add period before "</returns>" doc tag.
  • remove extra space before "</returns>" doc tag.
  • convert first char after "<returns>" doc tag to upper case .

PR Checklist

@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Dec 24, 2018
@iSazonov iSazonov force-pushed the style-docs-period-returns branch from 985f556 to f8940f6 Compare December 24, 2018 09:30
@iSazonov iSazonov closed this Dec 24, 2018
@iSazonov iSazonov reopened this Dec 24, 2018
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably just make it empty

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

/// <param name="args"> replacement params for resource string formatting </param>
/// <returns> </returns>
/// <returns>.</returns>
/// <remarks> </remarks>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in scope for this PR, but we should just remove these empty remarks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done #8538.

@iSazonov iSazonov merged commit 871ce56 into PowerShell:master Dec 25, 2018
@iSazonov iSazonov deleted the style-docs-period-returns branch December 25, 2018 16:43
@iSazonov iSazonov self-assigned this Dec 28, 2018
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.

2 participants

Comments