Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align formatting of all reports #150

Merged
merged 8 commits into from
Jan 22, 2025
Merged

Align formatting of all reports #150

merged 8 commits into from
Jan 22, 2025

Conversation

Pennycook
Copy link
Contributor

Related issues

Closes #147.

Proposed changes

  • Insert an empty line between logical blocks of output.
  • Use bold underlined or Markdown-style ==== headings for each report (depending on output stream configuration).
  • Tweak a few small formatting things (e.g., colons) for consistency across reports.
  • Deprecate -R all and fix the documentation of the -R flag in the -h output.

Here's a preview of how things look for the sample code base:

image

It may be worth cherry-picking the deprecation of -R all to 1.x and releasing a 1.3.0 just so that we can make a clean break in 2.0.0.

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]>
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]>
Improves readability by making it easier to distinguish between match sections.

Signed-off-by: John Pennycook <[email protected]>
@Pennycook Pennycook added the enhancement New feature or request label Jan 16, 2025
@Pennycook Pennycook added this to the 2.0.0 milestone Jan 16, 2025
@Pennycook Pennycook closed this Jan 16, 2025
@Pennycook Pennycook reopened this Jan 16, 2025
@laserkelvin laserkelvin mentioned this pull request Jan 17, 2025
6 tasks
Copy link
Contributor

@laserkelvin laserkelvin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Pennycook Pennycook merged commit 6450b98 into main Jan 22, 2025
5 of 6 checks passed
@Pennycook Pennycook deleted the report-format branch January 22, 2025 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve consistency of reports
2 participants