[debug_print_text] update readme

tgfrerer · Oct 23, 2024 · 903f407 · 903f407
1 parent 9e5da2f
commit 903f407
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/modules/le_debug_print_text/README.md b/modules/le_debug_print_text/README.md
@@ -21,8 +21,8 @@ le::DebugPrint::drawAllMessages(main_renderpass);
 ```
 
 Otherwise, all messages are rendered into the last renderpass that is
-part of [the](the.md) rendergraph, assuming that this renderpass is
-going to the screen.
+part of the rendergraph, assuming that this renderpass is going to the
+screen.
 
 `drawAllMessages()` clears the message state and resets the debug 
 message printer.

diff --git a/modules/le_debug_print_text/le_debug_print_text.h b/modules/le_debug_print_text/le_debug_print_text.h
@@ -6,8 +6,8 @@
 struct le_debug_print_text_o;
 struct le_renderpass_o;
 
+// Note the content of the next section is lifted from README.md
 /*
-
 # Debug Print Text
 
 ## A stateful debug printer for debug messages
@@ -31,8 +31,8 @@ le::DebugPrint::drawAllMessages(main_renderpass);
 ```
 
 Otherwise, all messages are rendered into the last renderpass that is
-part of [the](the.md) rendergraph, assuming that this renderpass is
-going to the screen.
+part of the rendergraph, assuming that this renderpass is going to the
+screen.
 
 `drawAllMessages()` clears the message state and resets the debug 
 message printer.