Query block grouped by heading - inline comment visible in heading but not in individual tasks - any idea why inconsistent?

[AnnaKornfeldSimpson]

Not a bug/issue, more of an unexpected behavior, so posting here. No idea what the "correct" behavior would be, quite possibly the existing behavior is correct. I was just surprised.

Note snippet:

## Tasks %% fold %%
- [ ] (GlobalFilter) Description
- [ ] (GlobalFilter) Wibble %% inline comment %% wobble

Tasks query for files that include that note snippet:

```tasks
heading includes Tasks
group by heading
hide task count
```

The output successfully includes both tasks grouped by heading, but the inline comment in the heading name is rendered along with the rest of the heading, while the inline comment in the task is not rendered.
Output of the query block:

...
## Tasks %% fold %%
- [ ] Description (backlink)(edit)
- [ ] Wibble  wobble (backlink)(edit)
...

Does anyone know why there is a difference in whether these inline comments are rendered? Obsidian's help page on note formatting has a short section on comments but it does not specify much detail about where comments are expected. Hiding the comment in the rendered task makes sense, and I guess I am surprised it was not hidden in the rendered heading as well. Thoughts?

Context: The comment in the heading comes from my usage of the community plugin Creases.

[claremacrae]

Yes, I can reproduce this. I had noticed the problem before with [[ ...]] not being rendered.

Here is a copyable chunk:

The Tasks

# 907 - fix - group titles not rendered

- [ ] [Query block grouped by heading - inline comment visible in heading but not in individual tasks - any idea why inconsistent? · Discussion #907 · obsidian-tasks-group/obsidian-tasks · GitHub](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/907)
- [ ] Fix display of links in group headings 

## 1 Heading with percent comment %% percent %%

- [ ] Task in Heading with percent comment

## 2 Heading with HTML comment <!-- HTML Comment -->

- [ ] Task in Heading with HTML comment

## 3 Heading with link to internal page [[907 - fix - group titles not rendered]]

- [ ] Heading with link to internal page

## 4 Heading with link to web page [#907](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/907)

How Obsidian renders

Which Obsidian renders - in Reading mode - as:

Tasks block

With this query:

```tasks
not done
path includes 907 - fix - group titles not rendered.md
hide backlink
group by heading
short mode
```

How Tasks renders

Tasks headings render as:

[claremacrae]

I need to mug up on how exactly to call MarkdownRenderer.renderMarkdown().

[AnnaKornfeldSimpson]

Wow, good catch on the links! I agree, that definitely makes this a Tasks bug.

[claremacrae]

It is definitely a bug - Tasks should render the headings the same way as Obsidian does.

Thanks very much for logging it. I'd been putting up with it, as I only rarely put any markup in headings.

[claremacrae]

I'll need to get someone to review the code, but here's my attempted fix:

diff --git a/src/QueryRenderer.ts b/src/QueryRenderer.ts
index 3d76900..671c3ed 100644
--- a/src/QueryRenderer.ts
+++ b/src/QueryRenderer.ts
@@ -1,4 +1,4 @@
-import { App, MarkdownRenderChild, Plugin, TFile } from 'obsidian';
+import { App, Component, MarkdownRenderChild, MarkdownRenderer, Plugin, TFile } from 'obsidian';
 import type { EventRef, MarkdownPostProcessorContext } from 'obsidian';
 
 import type { IQuery } from './IQuery';
@@ -256,7 +256,7 @@ class QueryRenderChild extends MarkdownRenderChild {
         }
     }
 
-    private static addGroupHeading(
+    private static async addGroupHeading(
         content: HTMLDivElement,
         group: GroupHeading,
     ) {
@@ -278,7 +278,7 @@ class QueryRenderChild extends MarkdownRenderChild {
                 cls: 'tasks-group-heading',
             });
         }
-        header.appendText(group.name);
+        await MarkdownRenderer.renderMarkdown(group.name, header, '/', null as unknown as Component);
     }
 
     private addBacklinks(

[AnnaKornfeldSimpson]

Wow! That was a speedy investigation and fix proposal! 🎉 I am not nearly awake enough to review code right now but I will look at this tomorrow if nobody else in an earlier timezone gets there first.

[claremacrae]

Before and after:

[claremacrae]

Wow! That was a speedy investigation and fix proposal! 🎉 I am not nearly awake enough to review code right now but I will look at this tomorrow if nobody else in an earlier timezone gets there first.

Thanks! I'll create a PR later this morning..

[claremacrae]

Note to self: When testing this, test the backlinks thoroughly for all these tasks with markdown in... This won't have changed them, but worth testing while I have the samples to hand.

[claremacrae]

PR submitted: #909

[claremacrae]

PR submitted: #909

And merged.

[claremacrae]

This was just released in Tasks 1.13.1