Fix incorrect and ambiguous help strings #6672
Open
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
|
clang-tidy review says "All clean, LGTM! 👍" |
maliberty
requested changes
Feb 9, 2025
Signed-off-by: Noah Moroze <[email protected]>
|
clang-tidy review says "All clean, LGTM! 👍" |
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.
This PR updates some help strings that are incorrect or ambiguous. These were caught by some old work I was doing on parsing OpenROAD help strings.
clock_tree_synthesis: a bunch of the switches were missing arguments, making them look like flagsdetailed_route_debug: putting braces around list items is more consistent with e.g.initialize_floorplan, and makes it explicit that these items need to be part of a list (rather than 4 separate words)repair_antennas: thediode_cellargument is optionalplace_pad: this one feels the least important since I think most people could infer this, but putting the positional argument makes it extra clear that-mirrordoesn't accept a value "name". I think this is also consistent with how some other help strings are defined.