Rename private methods in MshCommandRuntime.cs #9074
Merged
Conversation
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
11 tasks
iSazonov
reviewed
Mar 6, 2019
| /// to percolate up to the caller of ProcessRecord etc. | ||
| /// </exception> | ||
| internal void _WriteObjectsSkipAllowCheck(object sendToPipeline) | ||
| internal void _EnumerateAndWriteObjectSkipAllowCheck(object sendToPipeline) |
Collaborator
There was a problem hiding this comment.
Suggested change
| internal void _EnumerateAndWriteObjectSkipAllowCheck(object sendToPipeline) | |
| internal void EnumerateAndWriteObjectSkipAllowCheck(object sendToPipeline) |
Collaborator
Author
There was a problem hiding this comment.
If I go that route it might be better to just rename half the things in this file, in all honesty... There are a lot of similarly questionable names here.
Collaborator
There was a problem hiding this comment.
Oh, no. It is better to spend time to create something useful.
Collaborator
Author
There was a problem hiding this comment.
I'll come back to it when I'm really bored and do a proper style pass over the whole thing. 😉
Not a big-ticket item, but there's a lot of room for tidying up in this one. 😄
iSazonov
added
the
CL-CodeCleanup
iSazonov
approved these changes
Mar 6, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Summary
Renamed methods to avoid confusion when examining and maintaining core runtime code.
DoWriteObjects()->DoWriteEnumeratedObject()DoWriteObject()(no s) method._WriteObjectsSkipAllowCheck()->_EnumerateAndWriteObjectSkipAllowCheck()_WriteObjectSkipAllowCheck()This pair of methods is not actually referenced outside MshCommandRuntime.cs, and only in one or two places; I consider renaming it to be of no risk whatsoever as it is a private method.
There are no functional modifications, just renaming these before someone digs a little too deep here and breaks it by accident due to the very confusing naming scheme.
PR Context
As I was debugging #5955 I noticed that there are two pairs of commands in MshCommandRuntime.cs that deal with writing objects, one set which permits enumerating collections, the other which does not.
These are named far too similarly, where a mere typo could cause the wrong one to be used if this code is ever updated.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.[feature]to your commit messages if the change is significant or affects feature tests