Skip to content

Conversation

@iSazonov
Copy link
Collaborator

PR Summary

Instead of #7356.

Please review commit by commit.

  • The PR only remove empty public comment XML lines. Please don't request other changes.
  • The changes were made in Notepad++ by regex.

PR Checklist

/// <summary>
///
/// Retrieves input from the host virtual console and writes it to the pipeline output.
///
Copy link
Member

Choose a reason for hiding this comment

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

The regular expression should remove this whitespace unless the line after the whitespace contains text and not <.

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.

Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

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

@iSazonov I appreciate your passion to clean up the code, but perhaps we should discuss whether it's worth the review effort next time before you start a. PR as this was review took significant time.

/// <exception cref="System.ArgumentException">
/// path is null or empty.
/// </exception>
///
Copy link
Member

Choose a reason for hiding this comment

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

Missed this one

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Seems broken EOL.

Fixed.

/// start the playback
/// </summary>
internal virtual void ExecuteBufferPlayBack(DoPlayBackCall playback) { }

Copy link
Member

Choose a reason for hiding this comment

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

This whitespace should probably stay

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.

using System.Management.Automation.Host;
using System.Management.Automation.Internal;
using Microsoft.PowerShell.Commands.Internal.Format;

Copy link
Member

Choose a reason for hiding this comment

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

Put back this whitespace

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.

/// </summary>
[Parameter(ValueFromPipeline = true)]
public PSObject InputObject { set; get; } = AutomationNull.Value;

Copy link
Member

Choose a reason for hiding this comment

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

Put back this whitespace

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.

/// True if read succeeds.
/// </returns>
///
/// does not throw
Copy link
Member

Choose a reason for hiding this comment

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

Can we move this to inside the <summary/>?

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.

@iSazonov
Copy link
Collaborator Author

iSazonov commented Aug 1, 2018

@SteveL-MSFT We already have a tracking Issue but haven't plan. With the plan we'd freeze current PRs and spend 1-2 weeks to fix as many style issues as possible.

@iSazonov iSazonov changed the title Remove empty xml comment lines1 Remove empty xml comment lines Aug 1, 2018
@iSazonov iSazonov merged commit 5d03e16 into PowerShell:master Aug 1, 2018
@iSazonov iSazonov deleted the remove-empty-xml-comment-lines1 branch August 1, 2018 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants