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: Explain ignore global query #3365

Merged
merged 8 commits into from
Mar 2, 2025
Merged

Conversation

claremacrae
Copy link
Collaborator

@claremacrae claremacrae commented Mar 2, 2025

Types of changes

Changes visible to users:

  • New feature (prefix: feat - non-breaking change which adds functionality)
    • Issue/discussion:
    • WARNING: If the link is absent, the PR may be closed without review, due to the workload that such reviews usually require.
  • Documentation (prefix: docs - improvements to any documentation content for users)

Internal changes:

  • Refactor (prefix: refactor - non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
  • Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Description

Make ignore global query visible in explain output when it used outside of the Global Query.

Also explicitly confirm that the explain instruction is not explained, as it clutters up the docs and would not add any extra useful information.

Motivation and Context

Make the explain output cover all instructions.

How has this been tested?

  • New tests
  • Exploratory testing

Screenshots (if appropriate)

Sample note:

---
TQ_extra_instructions: |-
  ignore global query
  happens before today
---

# Explain Filters

## Show ignore global query

```tasks
explain
ignore global query
limit 1
```

Gives this:

image

Checklist

Terms

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

sonarqubecloud bot commented Mar 2, 2025

@claremacrae claremacrae merged commit de61d8f into main Mar 2, 2025
4 checks passed
@claremacrae claremacrae deleted the explain-remaining-instructions branch March 2, 2025 22:39
@claremacrae claremacrae changed the title feat: Explain 'ignore global filter' feat: Explain 'ignore global query' Mar 2, 2025
@claremacrae claremacrae changed the title feat: Explain 'ignore global query' feat: Explain ignore global query Mar 2, 2025
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