From 7df01d1cf6f6359722ce5cc5c63eed435b10a157 Mon Sep 17 00:00:00 2001 From: Nowaaru Date: Mon, 4 Nov 2024 00:42:12 -0700 Subject: [PATCH] utility/precognition: update descriptions needs docs link, desc is somewhat obscure. --- .../motion/precognition/precognition.nix | 25 ++++++++++++++++--- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/modules/plugins/utility/motion/precognition/precognition.nix b/modules/plugins/utility/motion/precognition/precognition.nix index 2af702e..6e0d31a 100644 --- a/modules/plugins/utility/motion/precognition/precognition.nix +++ b/modules/plugins/utility/motion/precognition/precognition.nix @@ -26,12 +26,22 @@ in { { foreground = "#0000FF"; background = "#000000"; }; ''; default = {link = "Comment";}; - description = "The highlight for the virtual text."; + description = '' + The highlight for the virtual text. + + To find more about this option, please see + [the documentation](https://github.com/tris203/precognition.nvim). + ''; }; hints = mkOption { default = {}; - description = "What motions display and at what priority."; + description = '' + What motions display and at what priority."; + + To find more about this option, please see + [the documentation](https://github.com/tris203/precognition.nvim). + ''; type = attrsOf (submodule { options = { text = mkOption { @@ -49,12 +59,19 @@ in { }; gutterHints = hints // - { description = "What motions display and at what priority. Only appears in gutters."; }; + { + description = '' + What motions display and at what priority. Only appears in gutters. + + To find more about this option, please see + [the documentation](https://github.com/tris203/precognition.nvim). + ''; + }; disabled_fts = mkOption { type = listOf str; default = ["startify"]; - example = literalExpression ''[ "startify" ]''; + example = literalExpression ''["startify"]''; }; }; }