Align formatting of all reports #150
Open
+82
−32
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
Previously, -h did not list the valid report types. Signed-off-by: John Pennycook <[email protected]>
"-R all" currently has the same behavior as not specifying "-R" at all. We intended to deprecate "-R all" in 1.2.0 but it looks like we forgot. Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Without this message, a first-time user of the clustering report would not necessarily realize that a dendrogram had been produced. Signed-off-by: John Pennycook <[email protected]>
Adopting a consistent convention for these functions is a necessary pre-requisite for sharing formatting functionality between them. Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Improves readability by making it easier to distinguish between match sections. Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
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.
Related issues
Closes #147.
Proposed changes
-R alland fix the documentation of the-Rflag in the-houtput.Here's a preview of how things look for the sample code base:
It may be worth cherry-picking the deprecation of
-R allto 1.x and releasing a 1.3.0 just so that we can make a clean break in 2.0.0.