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.

Sign up for GitHub

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

Jump to bottom

feat: Include layout instructions in 'explain' output #3364

Merged
merged 18 commits into from
Mar 2, 2025
Merged

feat: Include layout instructions in 'explain' output #3364

merged 18 commits into from
Mar 2, 2025

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

Internal changes:

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

Description

Include all the Layout instructions in explain output.

Motivation and Context

Fixes #2093.

How has this been tested?

  • Automated tests
  • Exploratory testing

Screenshots (if appropriate)

Checklist

Terms

claremacrae added 16 commits March 1, 2025 18:28
@claremacrae
refactor: - Add statement parameter to parseHideOptions()
4d5eac3
@claremacrae
refactor: . Remove unused line parameter from parseHideOptions()
0e9aef5
@claremacrae
refactor: - Extract statements variable in explainGroups()
22d7dab
@claremacrae
refactor: . Extract explainStatements()
97ca461
@claremacrae
refactor: . Inline statements
0725769
@claremacrae
refactor: - Reuse explainStatements() in explainSorters()
daf19ca
@claremacrae
feat: Explain show/hide of task fields
c98bc6c
@claremacrae
test: . Extract layoutExplanation variable
c7b88c4
@claremacrae
test: . Extract explainLayout()
7741b48
@claremacrae
test: . Inline layoutExplanation
06bd930
@claremacrae
test: . Inline source
96181c3
@claremacrae
feat: Explain show/hide of query options
d46bee1
@claremacrae
feat: Explain 'short' and 'short mode' instructions
021f119
@claremacrae
feat: Explain 'full' and 'full mode' instructions
ab0e012 
Fixes #2093
@claremacrae
docs: Update 'Explaining Queries' now layout instructions are explained
ddcf5d3
@claremacrae
refactor: . Fix misleading variable name
9d898d9
@claremacrae claremacrae added the scope: explain About the `explain` instruction which generates explanations of tasks query blocks label Mar 2, 2025
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Mar 2, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@claremacrae claremacrae merged commit 0aabc76 into main Mar 2, 2025
4 checks passed
@claremacrae claremacrae deleted the explain-layout-statements branch March 2, 2025 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
scope: explain About the `explain` instruction which generates explanations of tasks query blocks
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make 'explain' explain show and hide commands
1 participant
@claremacrae