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: Use indentation to separate global & code block query explanation #2538

Merged
merged 7 commits into from
Dec 26, 2023

Conversation

claremacrae
Copy link
Collaborator

Description

Use indentation in the explain output, so that it is easier to see which instructions are from the Global Query, and which from the Tasks Query Block.

Motivation and Context

I've been finding that it's quite hard to see the end of the Global Query explanation and the start of the Tasks Query Block explanation in my main vault.

How has this been tested?

  • Updating and adding automated tests
  • Exploratory testing in the demo vault.

Screenshots (if appropriate)

Before:

Explanation of the global query:

heading includes tasks

No grouping instructions supplied.

At most 50 tasks.

Explanation of this Tasks code block query:

not done

due next week =>
  due date is between:
    2022-10-24 (Monday 24th October 2022) and
    2022-10-30 (Sunday 30th October 2022) inclusive

No grouping instructions supplied.

After

Explanation of the global query:

  heading includes tasks

  No grouping instructions supplied.

  At most 50 tasks.

Explanation of this Tasks code block query:

  not done

  due next week =>
    due date is between:
      2022-10-24 (Monday 24th October 2022) and
      2022-10-30 (Sunday 30th October 2022) inclusive

  No grouping instructions supplied.

Types of changes

Changes visible to users:

  • New feature (prefix: feat - non-breaking change which adds functionality)
  • 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)

Checklist

Terms

@claremacrae claremacrae added the scope: explain About the `explain` instruction which generates explanations of tasks query blocks label Dec 26, 2023
@claremacrae claremacrae merged commit fa8562d into main Dec 26, 2023
2 checks passed
@claremacrae claremacrae deleted the indent-explanations branch December 26, 2023 21:05
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
Status: 🎉 Released
Development

Successfully merging this pull request may close these issues.

1 participant