search

amtoine / nu-git-manager

A collection of Nushell tools to manage Git repositories.
GNU General Public License v3.0
26 stars 2 forks source link

modules are missing extra usage in the documentation #172

Closed amtoine closed 6 months ago

amtoine commented 7 months ago

Describe the bug

related to

How to reproduce

  1. look at the source of nu-git-manager => it has a usage and extra usage
  2. look at the documentation of the module => there is only the usage

Expected behavior

i expected to see the extra usage as well

Configuration

key value
version 0.89.0
branch
commit_hash
build_os linux-x86_64
build_target x86_64-unknown-linux-gnu
rust_version rustc 1.73.0 (cc66ad468 2023-10-03)
rust_channel stable-x86_64-unknown-linux-gnu
cargo_version cargo 1.73.0 (9c4383fb5 2023-08-26)
build_time 2024-01-11 18:20:14 +01:00
build_rust_channel release
allocator mimalloc
features default, sqlite, trash, which, zip
installed_plugins clipboard copy, clipboard paste, gstat, nu_plugin_explore

Additional context

No response

amtoine commented 7 months ago

this will only require to apply the following patch and regenerate the documentation when Nushell ships the fix

diff --git a/toolkit.nu b/toolkit.nu
index 8c82379..a34b0cb 100644
--- a/toolkit.nu
+++ b/toolkit.nu
@@ -325,6 +325,8 @@ def document-module [
             "## Description",
             $module.usage,
             "",
+            $module.extra_usage,
+            "",
             "## Commands",
             $commands,
         ]