Improve Makefile documentation for command flag handling#377
Open
Shashank2125 wants to merge 1 commit intonidhaloff:masterfrom
Open
Improve Makefile documentation for command flag handling#377Shashank2125 wants to merge 1 commit intonidhaloff:masterfrom
Shashank2125 wants to merge 1 commit intonidhaloff:masterfrom
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
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
I’ve cleaned up and rewritten the comments in the Makefile section that defines individual command flags.
The goal was to make it easier for others to understand what this part of the file does and why the flags are set individually.
The functionality hasn’t changed — only the explanation and wording. I also replaced the “ugly hack” phrasing with a more descriptive note that explains the reasoning behind it.
Notes
No behavior change
Just documentation to make file beginner friendly