Replace magic strings with constants #8453
Closed
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
…es including documenting argument groups, individual arguments, adding notes, and documenting models, which made the method quite large and cumbersome. To improve this, I refactored the method into smaller and more manageable methods which handle a single responsibility.
… HelpCommandDocumentEventHandler class. They included 'Description','Synopsis', 'Options', and 'Output'. To improve this, I defined these constants globally at the top of each classes, such that if we need to change any of these constants in the future, we can do it in one place and the changes will propagate throughout the code
… aroud the _map_handlers, now errors will be handled gracefully
This reverts commit 8f940db.
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.
Previously, the strings 'win32' and 'darwin' are used in the code. These could be replaced with constants.
WINDOWS_PLATFORM = 'win32' and MACOS_PLATFORM = 'darwin'
". This change improves code readability by avoiding the use of magic strings."