From af71c11eff3a78b284efa5ee06c854046b1f50c4 Mon Sep 17 00:00:00 2001 From: Vhyrro Date: Thu, 8 Aug 2024 12:09:27 +0200 Subject: [PATCH] docs(introspector): improve documentation --- lua/neorg/modules/core/todo-introspector/module.lua | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lua/neorg/modules/core/todo-introspector/module.lua b/lua/neorg/modules/core/todo-introspector/module.lua index 3aad49f5c..b7b4a154c 100644 --- a/lua/neorg/modules/core/todo-introspector/module.lua +++ b/lua/neorg/modules/core/todo-introspector/module.lua @@ -1,11 +1,12 @@ --[[ file: Todo-Introspector - title: Displays how many subtasks are done in a task + title: See Your Progress at a Glance + description: The introspector module displays progress for nested tasks. summary: Module for displaying progress of completed subtasks in the virtual line. --- -When a todo list item has a list of subtasks this module enables virtual text in the top level item and displays the -progress of the subtasks. By default it displays in the format of [completed/total] (progress%). +When an item with a TODO status has children with their own TODOs this module enables virtual text in the top level item and displays the +progress of the subtasks. By default it displays in the format of `[completed/total] (progress%)`. --]] local neorg = require("neorg") local modules = neorg.modules