search

srobo / recurring-tasks

A collection of recurring tasks associated with Student Robotics' events
0 stars 5 forks source link

Adding HTML comments breaks Github's new tasklists #93

Closed WillB97 closed 2 months ago

WillB97 commented 7 months ago

The tasklist code:

```[tasklist]
### Dependencies
 - [ ] #1336 <!-- Prepare a livestream for the SR2024 Kickstart -->
 - [ ] #1337 <!-- [Meta] SR2024 Kickstart Event -->

Produces:

image

Which doesn't check the checkbox when the task is closed.

Removing the HTML codes like:

```[tasklist]
### Dependencies
 - [ ] #1336
 - [ ] #1337

Produces:

image

Which properly tracks tasks closing.

PeterJCLaw commented 7 months ago

Urgh, that's a shame.

Have you checked what happens to the older list style? If I recall correctly, those previously also got automatically checked when the task was completed. If the comments break that too then we should also consider a different spelling for those.

If not and we can keep the older style having the comments, then it would be better to re-factor the construction of that spelling into the conditional branch where it's used rather than having a variable which looks like it'll be used several times but then isn't.

It'd also be great to explore other spellings here. I had thought that adding text after the #number didn't break this, so maybe there's something else we can do?