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

feat: Simplify 'explain' text #3301

Merged
merged 2 commits into from
Feb 4, 2025
Merged

feat: Simplify 'explain' text #3301

merged 2 commits into from
Feb 4, 2025

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

  • New feature (prefix: feat - non-breaking change which adds functionality)
    • Issue/discussion: no direct request - but I have noticed since the addition of "Query File Defaults" that explain output is becoming very cluttered
  • Documentation (prefix: docs - improvements to any documentation content for users)

Internal changes:

  • Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Description

Remove this output from explain output:

  No grouping instructions supplied.

And this:

  No sorting instructions supplied.

Motivation and Context

Where there is both a "Global Query" and "Query File Defaults", that text could appear 3 times in explain output, making it just very cluttered, I found.

How has this been tested?

  • Exploratory testing
  • Updating existing automated tests

Screenshots (if appropriate)

Checklist

Terms

@claremacrae claremacrae added the scope: explain About the `explain` instruction which generates explanations of tasks query blocks label Feb 4, 2025
Copy link

sonarqubecloud bot commented Feb 4, 2025

@claremacrae claremacrae merged commit c25cc78 into main Feb 4, 2025
4 checks passed
@claremacrae claremacrae deleted the simplify-explain-results branch February 4, 2025 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: explain About the `explain` instruction which generates explanations of tasks query blocks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant