refactor: Rename DumpToYaml -> DumpNormalizedYAML #656
Conversation
This file contains 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
adombeck
commented
Nov 26, 2024
adombeck
force-pushed
the
rename-function
branch
from
bf054c6
to
81c2b3a
Compare
I was surprised that "DumpToYaml" modifies some values in the returned YAML. The new name should be less surprising. It also contains the acronym YAML in uppercase, as recommended by the Go Code Review Comments: https://go.dev/wiki/CodeReviewComments#initialisms Also improves the doc comment of the function.
adombeck
force-pushed
the
rename-function
branch
from
81c2b3a
to
8f367d9
Compare
adombeck
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I was surprised that "DumpToYaml" modifies some values in the returned YAML. The new name should be less surprising.
It also contains the acronym YAML in uppercase, as recommended by the Go Code Review Comments: https://go.dev/wiki/CodeReviewComments#initialisms
Also improves the doc comment of the function.
UDENG-5450