Content Helper: Refactor code for clarity #1069
Merged
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
acicovic
changed the title
chriszarate
reviewed
Sep 16, 2022
chriszarate
reviewed
Sep 16, 2022
chriszarate
previously approved these changes
Sep 16, 2022
…piQuery Co-authored-by: Chris Zarate <[email protected]>
chriszarate
approved these changes
Sep 20, 2022
acicovic
added
Type: Maintenance
Type: Refactoring
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.
Description
The original intent of this PR was to add a panel to the Content Helper with details about the current post, drawn from the Parse.ly API. However, during the process we discovered that some of our code needed refactoring in order to improve clarity and being able to keep adding panels without the code getting confusing.
To keep clarity and separation of concerns, this PR now focuses on those specific refactorings, where we change some variable/function/component names and add some function comments within the Content Helper in order to improve code clarity. The original work will be continue in another PR that will be based upon this branch.
Motivation and Context
Related: #1063.
How Has This Been Tested?
Tests pass.