comment: Record example reasons for not redrawing...

to help with future testing and debugging.

Author: claremacrae

src/Renderer/QueryRenderer.ts

@@ -260,13 +260,22 @@ class QueryRenderChild extends MarkdownRenderChild {
             // that we get correct values for isConnected and isShown().
             // (setTimeout(, 0) seemed to work too...)
             if (!this.containerEl.isConnected) {
+                // Example reasons why we might not be "connected":
+                // - This Tasks query block is contained with within another plugin's code block,
+                //   such as a Tabs plugin. The file is closed and that plugin has not correctly
+                //   tidied up, so we have not been deleted.
                 this.queryResultsRenderer.query.debug(
                     '[render] QueryRenderChild.render() Ignoring redraw request, as code block is not connected.',
                 );
                 return;
             }
 
             if (!this.containerEl.isShown()) {
+                // Example reasons why we might not be "shown":
+                // - We are in a collapsed callout.
+                // - We are in a note which is obscured by another note.
+                // - We are in a Tabs plugin, in a tab which is not at the front.
+                // - The user has not yet scrolled to this code block's position in the file.
                 this.queryResultsRenderer.query.debug(
                     '[render] QueryRenderChild.render() Ignoring redraw request, as code block is not shown.',
                 );